Documentation

There are three components to desilike’s documentation: docstrings, Sphinx documentation, and Jupyter notebooks.

For docstrings, desilike follows the NumPy docstring convention. Please ensure that all code contributions are accompanied by complete and error-free docstrings. Tools like ruff or darglint can help check docstring completeness.

The Sphinx documentation for desilike is built using Sphinx and hosted on Read the Docs. Please follow the Sphinx style guide when writing documentation. The documentation is stored in the docs folder.

The documentation can be built by running the following commands in a terminal:

cd /path/to/desilike/doc
make html

Note that you may have to install dependencies listed in docs/requirements.txt first. After building, the HTML pages can be accessed by opening _build/html/index.html with your web browser.

Finally, desilike also includes example notebooks stored in the nb folder. Please consider contributing example notebooks when adding new functionality to desilike.