update sphinx / spruce up the docs after many moons

.gitignore

@@ -1,7 +1,7 @@
 # Generated API from Exhale
 docs/api
 # Doxygen output (run by Exhale)
-docs/doxyoutput
+docs/_doxygen
 # Sphinx generated website
 docs/_build
 # generated by `make html`

.readthedocs.yml

@@ -0,0 +1,21 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

README.rst

@@ -22,7 +22,7 @@ HTML Theme choices:
 
 .. _companion:  https://github.com/svenevs/exhale-companion
 
-.. _rtd:       http://docs.readthedocs.io/en/latest/theme.html
+.. _rtd:       https://sphinx-rtd-theme.readthedocs.io/en/stable/
 .. _bstrap:    https://ryan-roemer.github.io/sphinx-bootstrap-theme/
 .. _alabaster: https://alabaster.readthedocs.io/en/latest/
 

docs/Makefile

@@ -1,10 +1,10 @@
 # Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = ExhaleCompanion
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 
@@ -15,13 +15,12 @@ help:
 .PHONY: help Makefile clean
 
 clean:
-	rm -rf doxyoutput/ api/
+	rm -rf _doxygen/ api/
 	# these are specific to the companion site, ignore this rm
-	rm -f conf_extensions.rst conf_theme.rst
+	rm -f conf_extensions.rst conf_theme.rst the_requirements.txt
 	@$(SPHINXBUILD) -M clean "$(SOURCEDIR)" "$(BUILDDIR)" $(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)
-