How to contribute ?
Documentation syntax
Every file in PyMT must have an header at least like this :
'''
Module name: short description
'''
Module name: short description
'''
The first documentation line of file is extracted by our tool to generate the API doc. Respect this format if you don't want to break things :)
For all other documentation in the code, use the reStructuredText syntax :
- Documentation on Sphinx : http://sphinx.pocoo.org/rest.html
- User manual on reStructuredText : http://docutils.sourceforge.net/rst.html
- A quickref : http://docutils.sourceforge.net/docs/user/rst/quickref.html#section-structure
For example, here is a simple header with documentation :
'''
Module name: short description
Big title
=========
Sub title with a very long long line
------------------------------------
Here we are, this is the first paragraph !
:)
'''
Module name: short description
Big title
=========
Sub title with a very long long line
------------------------------------
Here we are, this is the first paragraph !
:)
'''
Some useful tips:
- no space in header before title
- ==, --, ~~ must have the same size as title