AQ-AI / openaq-engine

http://www.aqai.xyz

BSD 3-Clause "New" or "Revised" License

2 stars 0 forks source link

Documentation for Submodules #75

Closed jit-1 closed 4 weeks ago

jit-1 commented 1 month ago

Description

Documentation for Submodules using Autodocs in Sphinx

Type of change

Please delete options that are not relevant.

[x] This change requires a documentation update

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes

jit-1 commented 1 month ago

Documentation to look at:

Autodoc Config Section: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/sphinx-config.html
How the docstrings need to be written in the Modules: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html