diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..a515ddb2 --- /dev/null +++ b/.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 diff --git a/README.rst b/README.rst index 8ad7f321..4acfd5dd 100644 --- a/README.rst +++ b/README.rst @@ -71,6 +71,13 @@ Example of AIOKafkaConsumer usage: asyncio.run(consume()) + +Documentation +------------- + +https://aiokafka.readthedocs.io/ + + Running tests ------------- diff --git a/docs/index.rst b/docs/index.rst index 52176727..97fb8eb5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -93,8 +93,6 @@ Installation pip install aiokafka -.. note:: **aiokafka** requires the kafka-python_ library. - Optional LZ4 install ++++++++++++++++++++