akvo / akvo-rsr

Akvo Really Simple Reporting
http://rsr.akvo.org
GNU Affero General Public License v3.0
39 stars 20 forks source link

[#5261] generate reference documentation from docstrings #5266

Closed MichaelAkvo closed 1 year ago

MichaelAkvo commented 1 year ago

TODO / Done

Summarize what has been changed / what has to be done in order to finalize the PR.

The choice for sphinx was due to its capability of recursively handling modules. Other options like portray, pdoc3, and mkdocs do not offer this possibility without significant effort (writing a custom handler). The result is not splendid (navigation is not intuitive), but it is usable and it can at least be expanded further.

Test plan

What tests are necessary to ensure this works or doesn't break anything working

Closes #5261

coveralls commented 1 year ago

Coverage Status

Coverage: 68.33% (+0.003%) from 68.328% when pulling 44ab1872dac627dc9d35013d7559aade8968a375 on feature/5261-generate-reference-documentation-from-docstrings into 30ba7b2452ff577a8c7456547efd58ecea384165 on master.