References¶
Sphinx and Rest References¶
This doc began as a fork of a 2011 version of Cristoph Reller reST Memo which is now part of his Programming Notes. I adapted it according to my needs, and they have largely diverged now, but it may still inherits from few content and layout.
Documenting Your Project Using Sphinx from an example pypi project’s
Awesome Sphinx a curated list of awesome extra libraries, software and resources for Sphinx.
sampledoc tutorial from matplotlib a python 2D plotting library.
rst2pdf is a tool for transforming reStructuredText to PDF using ReportLab. It supports Sphinx formatting.
How to write docstrings¶
Look at examples in Official list of projects using Sphinx
Documenting Python use Sphinx in function definitions it prefers to the pure Sphinx Syntax the Google style guide that is used in Full Code Example
Sources of mongo python driver are also a good example
Extending Sphinx¶
Defining Custom Roles in Sphinx a Sphinx blog post by Doug Hellmann
Creating Interpreted Text Roles from David Cooper docutils project.
Creating reStructuredText Directives from docutils project.