Good documentation is just as important as tests. ICEkit pull requests should endeavour to include and/or update documentation where appropriate.
ICEkit documentation is written in ReStructured Text (ReST) format, and compiled to HTML using Sphinx. Documentation is hosted on ReadTheDocs.
- Include examples so new contributors can get started quickly.
- Keep the Changelog up to date. Describe features, not implementation details, except for backwards incompatible changes.
- We’re aiming to document all non-private modules, classes and functions in
ICEkit. The easiest way to do this is in the docstrings of the class, with
automodulecall out from this document structure.
- Titles should be sentence case.
- File extensions are
.rstand hard-wrapped at 80 columns.
You’ll need a source installation of ICEkit.
Activate the ICEkit virtualenv, e.g. with
brew install pandoc
Install the python requirements:
pip install sphinx sphinx-autobuild recommonmark