Update documentation using Sphinx and include documentation from docstrings.
For this to work, the docstrings must of course be written in correct reStructuredText. You can then use all of the usual Sphinx markup in the docstrings, and it will end up correctly in the documentation. Together with hand-written documentation, this technique eases the pain of having to maintain two locations for documentation, while at the same time avoiding auto-generated-looking pure API documentation.
Generate the documentation using the following commands:
$ pip install sphinx
$ cd docs
$ make html
$ cd _build/html
$ python -m SimpleHTTPServer
Read the Docs can be used to host the documentation, readthedocs.org simplifies software documentation by automating building, versioning, and hosting of the docs. The main advantages of Read the Docs are:
Free documentation hosting
Webhooks available in GitHub to automatically build the documentation
Multiple versions supported
Read the Getting Started guide to get up and running with Read the Docs. You will have your document imported on Read the Docs in 5 minutes, displayed beautifully for the world.
Update documentation using Sphinx and include documentation from docstrings.
For this to work, the docstrings must of course be written in correct reStructuredText. You can then use all of the usual Sphinx markup in the docstrings, and it will end up correctly in the documentation. Together with hand-written documentation, this technique eases the pain of having to maintain two locations for documentation, while at the same time avoiding auto-generated-looking pure API documentation.
Generate the documentation using the following commands:
Read the Docs can be used to host the documentation, readthedocs.org simplifies software documentation by automating building, versioning, and hosting of the docs. The main advantages of Read the Docs are:
Read the Getting Started guide to get up and running with Read the Docs. You will have your document imported on Read the Docs in 5 minutes, displayed beautifully for the world.