Merged skeleton docs

Signed-off-by: Omkar Phansopkar <[email protected]>

docs/Makefile

@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SPHINXDEVBUILD = sphinx-autobuild
+SPHINXAUTOBUILD = sphinx-autobuild
 SOURCEDIR     = source
 BUILDDIR      = build
 
@@ -21,7 +21,7 @@ dev:
 	@echo
 	@echo "Starting up the auto-reloading development server..."
 	@echo
-	$(SPHINXDEVBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
+	$(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).

docs/make.bat

@@ -1,35 +1,48 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=source
-set BUILDDIR=build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
-	echo.
-	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
-	echo.installed, then set the SPHINXBUILD environment variable to point
-	echo.to the full path of the 'sphinx-build' executable. Alternatively you
-	echo.may add the Sphinx directory to PATH.
-	echo.
-	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
-	exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+if "%SPHINXAUTOBUILD%" == "" (
+	set SPHINXAUTOBUILD=sphinx-autobuild
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+if "%1" == "dev" goto dev
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:dev
+%SPHINXAUTOBUILD% -b html %SPHINXOPTS% %SOURCEDIR% %BUILDDIR%\html
+@echo
+@echo Starting up the auto-reloading development server...
+@echo
+%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -1,27 +1,4 @@
-alabaster
-Babel
-certifi
-chardet
-colorama
-docutils
-idna
-imagesize
-Jinja2==2.11.3
-MarkupSafe==1.1.1
-packaging
-Pygments
-pyparsing
-pytz
-requests
-six
-snowballstemmer
-Sphinx==2.4.4
-sphinx-autobuild
-sphinx_rtd_theme
-sphinxcontrib-applehelp
-sphinxcontrib-devhelp
-sphinxcontrib-htmlhelp
-sphinxcontrib-jsmath
-sphinxcontrib-qthelp
-sphinxcontrib-serializinghtml
-urllib3
+Sphinx>=5.0.2
+sphinx-rtd-theme>=1.0.0
+sphinx-reredirects >= 0.1.2
+doc8>=0.11.2

docs/scripts/doc8_style_check.sh

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

docs/scripts/sphinx_build_link_check.sh

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