From 9c8c8af26c72f8fddcc1738cc43bf30dbe8411bf Mon Sep 17 00:00:00 2001 From: Dana Powers Date: Wed, 12 Feb 2025 14:07:13 -0800 Subject: [PATCH] Fix apidoc publishing to readthedocs --- .readthedocs.yaml | 6 +++--- docs/conf.py | 5 +++-- docs/requirements.txt | 4 ++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dd2aa46c8..31dbf0d70 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,6 +30,6 @@ sphinx: # 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: docs/requirements.txt +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 2bc93bafb..c0caa2d13 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,11 +13,12 @@ # serve to show the default. import os +import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('../kafka/')) # -- General configuration ------------------------------------------------ @@ -103,7 +104,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/requirements.txt b/docs/requirements.txt index 0f095e074..61a675cab 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ -sphinx -sphinx_rtd_theme +sphinx==8.1.3 +sphinx_rtd_theme==3.0.2 # Install kafka-python in editable mode # This allows the sphinx autodoc module