1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
REST Primer:
http://www.sphinx-doc.org/en/stable/rest.html
REST and Sphinx Cheatsheet:
http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html#restructured-text-rest-and-sphinx-cheatsheet
Sphinx commands:
https://pythonhosted.org/an_example_pypi_project/sphinx.html
Sphinx domains (used to get links to other python packages and to the stdlib):
http://www.sphinx-doc.org/en/stable/domains.html
EG:
:py:mod:`sys`
:py:data:`sys.stdin`
:py:obj:`sys.stdin`
:mod:`sys`
:data:`sys.stdin`
:obj:`sys.stdin`
:class:`zipfile.ZipFile`
|
