CONTRIBUTING.rst

Contributing

Dependencies Tests/Developement (pip)

• tox
• coverage
• unittest2
• mock
• responses

Dependencies Documentation (pip)

• sphinx
• sphinxcontrib-napoleon
• sphinx_rtd_theme

Running Tests

from project root:

• python setup.py test

Full Suite

Run: tox (refer to tox.ini):

• Python2.7
• Python3.4
• py3kwarn
• pep8 (using flake8)
• build current docs

Building PyOTRS package: python setup.py sdist

Writing Documentation

Google Docstring format for

• Args: (includes **kwargs)
• Returns:
• Raises:
• Examples:

https://sphinxcontrib-napoleon.readthedocs.org/en/latest/ https://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google

For a Spinx formatted "Note" or "Warning" use .rst Syntax:

• .. note::
• .. warning::

http://www.sphinx-doc.org/en/stable/markup/para.html http://www.sphinx-doc.org/en/stable/rest.html http://docutils.sourceforge.net/docs/user/rst/quickref.html#escaping https://gist.github.com/dupuy/1855764