CODE CLINIC 27/02 - Documentation

[vbellemin]

Documentation

• Vignette(s) / Example usage: demonstrating major functionality (ideally to solve real-world analysis problems).
• Function Documentation: for functions used in the examples.

[vbellemin]

Comment on the Documentation :

• The link of the documentation is not visible in the README.
• The documentation is using an old version of readthedocs.
• Function documentation : The documentation doesn't include the function documentation. It doesn't use the automatic documentation generation from sources (for documenting the functions for instance). It should include a config file in .yaml and a .toml file. Info on this link : https://docs.readthedocs.com/platform/stable/tutorial/index.html
• Vignette / Example usage : The documentation doesn't include vignettes for example usage. README example could be one example.
• Add a video (GIF) or a nice plot on the main page (index.rst)

Link of a nice readthedocs.io made by Alban Farchi at CEREA : https://pyshqg.readthedocs.io/en/latest/index.html

[vbellemin]

Example to help writing the documentation : https://my-documented-code-test.readthedocs.io/en/latest/