From bcbaa29ea97dbb2eba60ef7374857504e00669f1 Mon Sep 17 00:00:00 2001 From: danielhasan1 Date: Wed, 19 Aug 2026 00:38:32 +0530 Subject: [PATCH] Fix broken Read the Docs build: install sphinx_rtd_theme docs/conf.py requires sphinx_rtd_theme, but .readthedocs.yml never installed it - the requirements section was commented out and pointed at a nonexistent ex-docs/requirements.txt (the docs directory has always been docs/). Every RTD build has failed with ModuleNotFoundError: sphinx_rtd_theme as a result, including the just published v0.4.0 tag build. Verified locally: pip install -r docs/requirements.txt in a clean venv, then the same sphinx-build invocation RTD uses, builds cleanly. --- .readthedocs.yml | 14 ++++++++------ docs/requirements.txt | 2 ++ 2 files changed, 10 insertions(+), 6 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index 59041e1..981e5fe 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -15,15 +15,17 @@ build: # rust: "1.64" # golang: "1.19" -# Build documentation in the ex-docs/ directory with Sphinx +# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py -# If using Sphinx, optionally build your ex-docs in additional formats such as PDF +# If using Sphinx, optionally build your docs in additional formats such as PDF # formats: # - pdf -# Optionally declare the Python requirements required to build your ex-docs -# python: -# install: -# - requirements: ex-docs/requirements.txt \ No newline at end of file +# Python requirements required to build the docs (sphinx_rtd_theme, used by +# docs/conf.py, isn't installed by default - without this the build fails +# with ModuleNotFoundError: sphinx_rtd_theme) +python: + install: + - requirements: docs/requirements.txt \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..8213302 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx +sphinx_rtd_theme