Merge pull request #21 from aboutcode-org/fix-failing-rtd-build

Fix Failing Read the Docs Build

Author: keshav-space

Makefile

@@ -60,7 +60,7 @@ black:
 
 doc8:
 	@echo "-> Run doc8 validation"
-	@${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/build/ --quiet docs/
+	@${ACTIVATE} doc8 --max-line-length 100 --ignore-path docs/_build/ --quiet docs/
 
 valid: isort black doc8
 
@@ -95,8 +95,8 @@ test:
 	@${ACTIVATE} pytest -vvs
 
 docs:
-	rm -rf docs/build/
-	@${ACTIVATE} sphinx-build docs/ docs/build/
+	rm -rf docs/_build/
+	@${ACTIVATE} sphinx-build docs/source docs/_build/
 
 postgresdb:
 	@echo "-> Configure PostgreSQL database"

docs/Makefile

@@ -5,7 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SPHINXAUTOBUILD = sphinx-autobuild
+SOURCEDIR     = source
 BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
@@ -14,7 +15,14 @@ help:
 
 .PHONY: help Makefile
 
+# Run the development server using sphinx-autobuild
+docs:
+	@echo
+	@echo "Starting up the docs server..."
+	@echo
+	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/changelog.rst

@@ -7,11 +7,16 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
-set BUILDDIR=_build
+if "%SPHINXAUTOBUILD%" == "" (
+	set SPHINXAUTOBUILD=sphinx-autobuild
+)
+set SOURCEDIR=source
+set BUILDDIR=build
 
 if "%1" == "" goto help
 
+if "%1" == "docs" goto docs
+
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
@@ -28,6 +33,13 @@ if errorlevel 9009 (
 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 goto end
 
+:docs
+@echo
+@echo Starting up the docs server...
+@echo
+%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+goto end
+
 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 

docs/make.bat

@@ -2,4 +2,4 @@
 # halt script on error
 set -e
 # Check for Style Code Violations
-doc8 --max-line-length 100 --ignore D000 --ignore-path build --quiet .
+doc8 --max-line-length 100 source --ignore D000 --quiet

docs/scripts/doc8_style_check.sh

@@ -2,4 +2,4 @@
 # halt script on error
 set -e
 # Build locally, and then check links
-sphinx-build -E -W -b linkcheck . build
+sphinx-build -E -W -b linkcheck source build

docs/scripts/sphinx_build_link_check.sh

@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst

docs/application-settings.rst docs/source/application-settings.rstdocs/application-settings.rst renamed to docs/source/application-settings.rst

@@ -75,6 +75,18 @@
 
 master_doc = "index"
 
+html_context = {
+    "display_github": True,
+    "github_user": "aboutcode-org",
+    "github_repo": "federatedcode",
+    "github_version": "main",  # branch
+    "conf_py_path": "/docs/source/",  # path in the checkout to the docs root
+}
+
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = True
+
 # user starts in light mode (Default Mode)
 default_dark_mode = False