Getting Started with Sphinx and readthedocs.org

• new github repo

• readthedocs.org account

• install sphinx (debian package?)

• https://docs.readthedocs.io/en/latest/intro/getting-started-with-sphinx.html

• sphinx-quickstart

• edit index.rst

• run make html to check if it works

• commit and push your files to Github (but without the HTML files!)

• create a new project at readthedocs.org using your Github repo

• go to Github admin section, then to service hooks, activate ReadTheDocs

Links

Code: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#showing-code-examples

TODO

• try TikZ extension: https://bitbucket.org/philexander/tikz