Docs: Add note re debug logging; add OffsetAndMetadata/TopicPartition

Author: dpkp

README.rst

@@ -228,3 +228,15 @@ testing, probing, and general experimentation. The protocol support is
 leveraged to enable a KafkaClient.check_version() method that
 probes a kafka broker and attempts to identify which version it is running
 (0.8.0 to 2.6+).
+
+
+Debugging
+*********
+
+Use python's `logging` module to view internal operational events.
+See https://docs.python.org/3/howto/logging.html for overview / howto.
+
+.. code-block:: python
+
+    import logging
+    logging.basicConfig(level=logging.DEBUG)

docs/apidoc/OffsetAndMetadata.rst

@@ -0,0 +1,2 @@
+.. autoclass:: kafka.OffsetAndMetadata
+    :members:

docs/apidoc/TopicPartition.rst

@@ -0,0 +1,2 @@
+.. autoclass:: kafka.TopicPartition
+    :members:

docs/index.rst

@@ -223,6 +223,18 @@ method that probes a kafka broker and
 attempts to identify which version it is running (0.8.0 to 2.6+).
 
 
+Debugging
+*********
+
+Use python's `logging` module to view internal operational events.
+See https://docs.python.org/3/howto/logging.html for overview / howto.
+
+.. code-block:: python
+
+    import logging
+    logging.basicConfig(level=logging.DEBUG)
+
+
 .. toctree::
    :hidden:
    :maxdepth: 2