Notes

Quickstart

Infrastructure

Docutils

Step

1. pip install Sphinx

2. sphinx-quickstart

3. make html

Extra

1. sphinx-build -b linkcheck . _build/linkcheck

Tools

sphinx-autobuild

sphinx-autobuild

pip install sphinx-autobuild
# cd to above docs directory
sphinx-autobuild docs docs/_build/html
# or
sphinx-autobuild . _build/html

Publishing

Read the Docs

1. upload your docs to github

2. create requirements.txt

3. import your project on the read the docs