A compact cheat sheet for writing documentation string for Sphinx, with focus on Python.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
rest_sphinx_cheatsheet.odt
rest_sphinx_cheatsheet.pdf

README.md

Sphinx reStructuredText (reST) Cheatsheet

A compact cheat sheet for writing documentation strings in Python (and other languages) using reStructuredText markup. The documentation can be subsequently generated by Sphinx.

Download the cheatsheet PDF here.