Documentation

Documentation is an essential part of every software project. It helps users install and use the software, contributors learn extend and improve it, and maintainers keep the sustain and grow the project over time. Without documentation, even excellent code can go unused!

In this section, you will find recommendations on:

• Code documentation: how to document your code using Python docstrings

• Documentation websites: how to build and publish documentation websites using tools such as Jupyter Book, Sphinx, and Read the Docs

• Contributing to the ORMIR documentation: how to contribute to the ORMIR community’s documentation.