From 9af4531d49c4eb928cc7e79053c9c06c4976278d Mon Sep 17 00:00:00 2001 From: tdruez Date: Thu, 7 Dec 2023 21:47:11 +0400 Subject: [PATCH] Declare documentation dependencies in docs/requirements.txt Signed-off-by: tdruez --- .readthedocs.yaml | 3 +-- Makefile | 2 +- docs/index.rst | 1 - docs/requirements.txt | 2 ++ 4 files changed, 4 insertions(+), 4 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 5a1cf6d2..5399ec03 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,8 +13,7 @@ build: # Optionally declare the Python requirements required to build your docs python: install: - - method: pip - path: Sphinx furo + - requirements: docs/requirements.txt # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/Makefile b/Makefile index 04538607..f3c3c640 100644 --- a/Makefile +++ b/Makefile @@ -137,7 +137,7 @@ test: docs: @echo "-> Builds the installation_and_sysadmin docs" rm -rf ${DOCS_LOCATION}/_build/ - @${ACTIVATE} pip install Sphinx sphinx_rtd_theme furo + @${ACTIVATE} pip install -r docs/requirements.txt @${ACTIVATE} sphinx-build -b singlehtml ${DOCS_LOCATION} ${DOCS_LOCATION}/_build/singlehtml/ @${ACTIVATE} sphinx-build -b html ${DOCS_LOCATION} ${DOCS_LOCATION}/_build/html/ diff --git a/docs/index.rst b/docs/index.rst index 7fa8a8c4..ce79b276 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,7 +39,6 @@ Welcome to the very start of your DejaCode journey! :maxdepth: 1 :caption: Miscellaneous - license contributing changelog doc_maintenance diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..c4a09952 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx==7.2.6 +furo==2023.9.10