Merge pull request #1 from nexB/rtd_conf

Proper setup for readthedocs configuration and builds
aboutcode-org · Dec 7, 2023 · fa0746f · fa0746f
2 parents 78070f0 + 9af4531
commit fa0746f
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 6 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,10 +13,7 @@ build:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-      - method: pip
-        path: .
-        extra_requirements:
-           - dev
+      - requirements: docs/requirements.txt
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:

diff --git 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
@@ -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
@@ -0,0 +1,2 @@
+Sphinx==7.2.6
+furo==2023.9.10