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.

• Sphinx documentation

• Sphinx reStructuredText Primer

• Python Development Guide: reStructuredText markup

• 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.

• The ReStructuredText Documentation

  • Docutil reStructuredText Primer you may prefer the *Sphinx* nicely formatted documentation cited above.

  • Quick reStructuredText

  • reStructuredText Markup Specification

  • reST Directives

  • Interpreted Text Roles

  • Emacs Support for reStructuredText

• Rst Cheatsheet

• Documenting Python in the Python Developer’s Guide

• sampledoc tutorial from matplotlib a python 2D plotting library.

• rst2pdf is a tool for transforming reStructuredText to PDF using ReportLab. It supports Sphinx formatting.

• Epydoc reST markup

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

• OpenAlea Wiki - Docstrings

• Google style guide.

• NumPy style guide.

• Sources of mongo python driver are also a good example

Extending Sphinx

• Extending Sphinx

• Creating directives and roles

• Tutorial: adds support for new type for autodoc

• Defining Custom Roles in Sphinx a Sphinx blog post by Doug Hellmann

• Creating Interpreted Text Roles from David Cooper docutils project.

• Creating reStructuredText Interpreted Text Roles (2)

• Creating reStructuredText Directives from docutils project.