Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
code_documentation [2013/06/21 09:05]
Stefan [Writing]
code_documentation [2016/01/13 14:14] (current)
Line 4: Line 4:
  
 The psysmon source code documentation is done using the Python docstrings formatted by the NumPy/SciPy documentation style. The [[https://​github.com/​numpy/​numpy/​blob/​master/​doc/​HOWTO_DOCUMENT.rst.txt | guide to NumPy/SciPy documentation]] gives details about the docstring formatting. The psysmon source code documentation is done using the Python docstrings formatted by the NumPy/SciPy documentation style. The [[https://​github.com/​numpy/​numpy/​blob/​master/​doc/​HOWTO_DOCUMENT.rst.txt | guide to NumPy/SciPy documentation]] gives details about the docstring formatting.
 +
 +Following you will find some useful topics that are frequently used for documenting the source code.
 +
 +==== Cross referencing ====
 +With Sphinx it's easy to add various cross references to other sphinx documents.
 +Here is a [[http://​sphinx-doc.org/​markup/​inline.html | description of the cross referencing]].
 +
 +To cross reference to python objects, there are some useful cross referencing roles: [[http://​sphinx-doc.org/​domains.html#​python-roles | Cross-referencing Python objects]].
 +
 +The docstring tags are '':​mod:'',​ '':​func:'',​ '':​data:'',​ '':​const:'',​ '':​class:'',​ '':​meth:'',​ '':​attr:'',​ '':​exc:''​ and '':​obj''​.
 +
 +
 ===== Building ===== ===== Building =====
   * [[code_documentation:​building | Building the source code documentation]]   * [[code_documentation:​building | Building the source code documentation]]