diff --git a/doc/source/development_guidelines.rst b/doc/source/development_guidelines.rst index 8fbda2b0c1..d679d7536d 100644 --- a/doc/source/development_guidelines.rst +++ b/doc/source/development_guidelines.rst @@ -203,19 +203,20 @@ The documentation in docstrings should follow the PEP 257 conventions More specifically: - 1. Triple quotes should be used for all docstrings. - 2. If the docstring is simple and fits on one line, then just use - one line. - 3. For docstrings that take multiple lines, there should be a newline - after the opening quotes, and before the closing quotes. - 4. Sphinx is used to build documentation, so use the restructured text - markup to designate parameters, return values, etc. Documentation on - the sphinx specific markup can be found here: - http://sphinx.pocoo.org/markup/index.html +#. Triple quotes should be used for all docstrings. +#. If the docstring is simple and fits on one line, then just use + one line. +#. For docstrings that take multiple lines, there should be a newline + after the opening quotes, and before the closing quotes. +#. Sphinx is used to build documentation, so use the restructured text + markup to designate parameters, return values, etc. Documentation on + the sphinx specific markup can be found here: + http://sphinx.pocoo.org/markup/index.html Installing Sphinx: - #. Install sphinx (On Ubuntu: `sudo apt-get install python-sphinx`) - #. `python setup.py build_sphinx` + +#. Install sphinx (On Ubuntu: ``sudo apt-get install python-sphinx``) +#. ``python setup.py build_sphinx`` -------- Manpages