Skip to content

Commit a57c881

Browse files
lowercase24edenhill
authored andcommitted
Add CachedSchemaRegistryClient to generated docs (@lowercase24, #495)
* 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
1 parent 021b575 commit a57c881

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

confluent_kafka/avro/cached_schema_registry_client.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ class CachedSchemaRegistryClient(object):
5050
5151
See http://confluent.io/docs/current/schema-registry/docs/intro.html for more information.
5252
53-
.. deprecated::
53+
.. deprecated:: 1.1.0
54+
5455
Use CachedSchemaRegistryClient(dict: config) instead.
5556
Existing params ca_location, cert_location and key_location will be replaced with their librdkafka equivalents:
5657
`ssl.ca.location`, `ssl.certificate.location` and `ssl.key.location` respectively.

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Avro
4444
.. automodule:: confluent_kafka.avro
4545
:members:
4646

47+
.. autoclass:: confluent_kafka.avro.CachedSchemaRegistryClient
48+
:members:
4749

4850
*******
4951
Message
@@ -147,4 +149,3 @@ The Python bindings also provide some additional configuration properties:
147149
mylogger = logging.getLogger()
148150
mylogger.addHandler(logging.StreamHandler())
149151
producer = confluent_kafka.Producer({'bootstrap.servers': 'mybroker.com'}, logger=mylogger)
150-

0 commit comments

Comments
 (0)