malariagen / malariagen-data-python

Analyse MalariaGEN data from Python
https://malariagen.github.io/malariagen-data-python/latest/
MIT License
13 stars 23 forks source link

Review lists of functions to included in the API documentation #442

Closed leehart closed 10 months ago

leehart commented 10 months ago

Source RST files to be reviewed and potentially updated:

"Dev" documentation should be re-generated automatically via the .github/workflows/latest_docs.yml GitHub Actions upon push/merge with the master branch, added to the gh-pages branch, and deployed here:

leehart commented 10 months ago

If desirable, I imagine there would be a way to make this more automatic, if we ever wanted to move away from manual curation/maintenance, e.g. get a sorted list of all functions and properties but exclude any with an underscore prefix (or some other exclusion criterion, e.g. marked in the source code or some other list).