README.md

An Experiment

Sphinx

Initialise a Sphinx Documentation docs directory via:

mkdir docs && cd docs && sphinx-quickstart

Final part alternative

sphinx-quickstart --ext-autodoc --ext-intersphinx --ext-coverage --ext-mathjax 
  --ext-viewcode --ext-githubpages --extensions=revitron_sphinx_theme 
    --extensions=autodocsumm --extensions=sphinxcontrib.httpdomain 
      --extensions=sphinx.ext.napoleon --extensions=sphinxext.opengraph

Build the HTML pages via:

sphinx-build -E -b html docs/source docs/build/html

Remote Development

For further development via a container, the .devcontainer directory has

• requirements.txt
• Dockerfile

The requirements file lists the packages/libraries required for development. An image is built via the command:

docker build . --file .devcontainer/Dockerfile --tag design

Subsequently, a development container is initialised via the command

docker run --rm -i -t -p 127.0.0.1:10000:8888 -w /app \
  --mount type=bind,src="$(pwd)",target=/app design

Whereby:

• --rm
• -i
• -t
• -p

Local Development

Alternatively, a local virtual environment can be built via environment.yml; environment.yml uses the same requirements.txt as Dockerfile.

References

• GitHub Raw

• Google Hosted Libraries

• Revitron Theme

• Requirements File Format

• RST Footnotes

• favicon.io

• revitron

• revitron sphinx theme

• read the docs sphinx theme

  • source links
  • configuring

• Theming

• Sphinx Extensions

• sphinx-contrib

• sphinx-quickstart