<– Return to home page

Documentation techniques

Best practises

1. Describe our code.
2. Adopt a unified style
3. Create docstrings for all public classes, methods, functions, and modules.
4. Incorporate illustrations in the writing
5. Maintain a changelog.
6. Describe limitations
7. Don’t document internal information
8. Create appealing documentation with Sphinx.
9. Store our records online
10. Ensure that all of our documentation is current.

Click here for detailed information on best practises.

Creation of documentation

The code document in PAMI is done using reStructuredText markup language. The documentation is generated using Sphinx.

Click here to check the reStructuredText markup language.