RTD Resources

Getting started

• http://docs.readthedocs.io/en/latest/getting_started.html

• https://github.com/rtfd/readthedocs.org/blob/master/docs/getting_started.rst

Don’t be afraid to commit

• http://dont-be-afraid-to-commit.readthedocs.io/en/latest/documentation.html

First steps with Sphinx

• http://www.sphinx-doc.org/en/stable/tutorial.html

Sphinx markup reference

• http://www.sphinx-doc.org/en/stable/rest.html

reStructuredText Directives

• http://docutils.sourceforge.net/docs/ref/rst/directives.html

The Sphinx build configuration file

• http://www.sphinx-doc.org/en/master/config.html

Documenting your project with Sphinx

• https://pythonhosted.org/an_example_pypi_project/sphinx.html

Sphinx Read the Docs theme

• https://github.com/rtfd/sphinx_rtd_theme

Sphinx-autobuild

• https://github.com/GaretJax/sphinx-autobuild

Why you shouldn’t use markdown

• http://ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/

Beginners Guide to Sphinx-Setup

• https://github.com/neos/neos/blob/3.1/Documentation/Contribute/Documentation/BeginnersGuide.rst