Sphinx and ReST syntax for Python documentation

Sphinx is a tool that ease the creation of documentation for computer languages such as Python but also C/C++. The Sphinx syntax is an extension to the ReST (or RST) syntax. The drawback is that you need to learn another language, but it remains quite simple and its advantage is that it remains human readable (useful for the docstrings in Python!).

I put a rough guide to the Sphinx and ReST syntax. It can be found on my main page Sphinx and ReST guide. I consider it as a draft, but it should already be of interest for some of you.

Please follow and like us:
This entry was posted in Python and tagged , , . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *