From 4b662981a73c118e296624edae028e07909c823c Mon Sep 17 00:00:00 2001 From: Bastian Krause Date: Thu, 14 Mar 2024 09:48:59 +0100 Subject: [PATCH] .readthedocs.yaml: add docs requirements to fix rtd build In the past readthedocs installed sphinx-rtd-theme implicitly, but not anymore. So add a requirements.in with sphinx and sphinx-rtd-theme, use pip-compile to create a pinned requirements.txt and reference that in the .readthedocs.yaml. Signed-off-by: Bastian Krause --- .readthedocs.yaml | 4 +++ docs/requirements.in | 3 +++ docs/requirements.txt | 57 +++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 64 insertions(+) create mode 100644 docs/requirements.in create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index faed0469..e88e6c7a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,3 +7,7 @@ build: sphinx: configuration: docs/conf.py + +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 00000000..0d4d6b9c --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,3 @@ +# use pip-compile requirements.in to update requirements.txt +sphinx +sphinx-rtd-theme diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..2d9ed99d --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,57 @@ +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile requirements.in +# +alabaster==0.7.16 + # via sphinx +babel==2.14.0 + # via sphinx +certifi==2024.2.2 + # via requests +charset-normalizer==3.3.2 + # via requests +docutils==0.20.1 + # via + # sphinx + # sphinx-rtd-theme +idna==3.6 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.3 + # via sphinx +markupsafe==2.1.5 + # via jinja2 +packaging==24.0 + # via sphinx +pygments==2.17.2 + # via sphinx +requests==2.31.0 + # via sphinx +snowballstemmer==2.2.0 + # via sphinx +sphinx==7.2.6 + # via + # -r requirements.in + # sphinx-rtd-theme + # sphinxcontrib-jquery +sphinx-rtd-theme==2.0.0 + # via -r requirements.in +sphinxcontrib-applehelp==1.0.8 + # via sphinx +sphinxcontrib-devhelp==1.0.6 + # via sphinx +sphinxcontrib-htmlhelp==2.0.5 + # via sphinx +sphinxcontrib-jquery==4.1 + # via sphinx-rtd-theme +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-qthelp==1.0.7 + # via sphinx +sphinxcontrib-serializinghtml==1.1.10 + # via sphinx +urllib3==2.2.1 + # via requests