Add CachedSchemaRegistryClient to generated docs (@lowercase24, confluentinc#495)

lowercase24 · edenhill · commit a57c88196d80 · 2019-08-22T08:38:22.000+02:00
* adding CachedSchemaRegistryClient to the docs to be generated.
This occurred because the automodule directive doesn't recursively
include child modules.  Added explicitly the missing class.

* updating the formatting of index.rst and updating docs to properly
use the deprecated directive

* cleaning up the deprecation warning
diff --git a/confluent_kafka/avro/cached_schema_registry_client.py b/confluent_kafka/avro/cached_schema_registry_client.py
@@ -50,7 +50,8 @@ class CachedSchemaRegistryClient(object):
 
     See http://confluent.io/docs/current/schema-registry/docs/intro.html for more information.
 
-    .. deprecated::
+    .. deprecated:: 1.1.0
+
     Use CachedSchemaRegistryClient(dict: config) instead.
     Existing params ca_location, cert_location and key_location will be replaced with their librdkafka equivalents:
     `ssl.ca.location`, `ssl.certificate.location` and `ssl.key.location` respectively.
diff --git a/docs/index.rst b/docs/index.rst
@@ -44,6 +44,8 @@ Avro
 .. automodule:: confluent_kafka.avro
    :members:
 
+.. autoclass:: confluent_kafka.avro.CachedSchemaRegistryClient
+   :members:
 
 *******
 Message
@@ -147,4 +149,3 @@ The Python bindings also provide some additional configuration properties:
     mylogger = logging.getLogger()
     mylogger.addHandler(logging.StreamHandler())
     producer = confluent_kafka.Producer({'bootstrap.servers': 'mybroker.com'}, logger=mylogger)
-
