Documentation Methodology

[Jireland2803]

Description

ROxygen – python equivalent:
roxygen2 equivalent for python - Stack Overflow

Can you use pkgdown in python?

Why this is important?

N/A

[Jireland2803]

interrogate — interrogate checks your code base for missing docstrings. Documentation should be as important as the code itself. And it should live within the code.

https://interrogate.readthedocs.io/en/latest/

[rmbielby]

Just adding this central Python guidance as well:
https://py-pkgs.org/06-documentation.html#documentation-table
It flags Sphinx for automation as well.