0

I'm researching open-source tools and packages to generate Python documentation for modules and functions containing docstrings.

I understand sphinx is good for parsing manually created docstrings written with thereStructuredText markup syntax.

A second option I found relevant is epydoc, which can also parse reStructuredText. It appears to be automated rather than manual, and focused on documenting APIs.

Is there a use case for both including both tools?

Are here any other tools to consider?

1 Answer 1

0

As of February 2018, Peter Kong's medium article provides a good review of the available Python documentation tools.

It seems that epydoc may not support Python3 and a successor has been developed. Sphinx provides the more comprehensive solution while Pdoc is simpler to install and may suffice for smaller projects.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Not the answer you're looking for? Browse other questions tagged or ask your own question.