Add readthedocs config (#1034)

Author: ods

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements-docs.txt

README.rst

@@ -71,6 +71,13 @@ Example of AIOKafkaConsumer usage:
 
     asyncio.run(consume())
 
+
+Documentation
+-------------
+
+https://aiokafka.readthedocs.io/
+
+
 Running tests
 -------------
 

docs/index.rst

@@ -93,8 +93,6 @@ Installation
 
     pip install aiokafka
 
-.. note:: **aiokafka** requires the kafka-python_ library.
-
 
 Optional LZ4 install
 ++++++++++++++++++++