For Developers

Contents

• For Developers

  • Standards and Tools

  • Cheat sheet

Standards and Tools

Please comply with the following standards/guides as much as possible.

Coding style

• PEP 8: https://www.python.org/dev/peps/pep-0008/

CHANGELOG

• Keep a Changelog: https://keepachangelog.com/en/1.0.0/

Versioning

• Semantic Versioning: https://semver.org/spec/v2.0.0.html

Packaging

• PyPA: https://www.pypa.io

• python-packaging: https://python-packaging.readthedocs.io

Documentation

• NumPy docstrings: https://numpydoc.readthedocs.io/en/latest/format.html

• Sphinx: https://www.sphinx-doc.org/

• Read The Docs: https://readthedocs.org/

• Documenting Python Code: A Complete Guide: https://realpython.com/documenting-python-code/

Cheat sheet

Sphinx

Generate documentation base, in docs/,

sphinx-quickstart

Select separate build and source files when prompted.

Preview documentation page with modified source, in docs/

make html

Open index.html with a browser (if this was set as the first page).