After having written some python scripts with comments for documentation inside, is it a good idea and possible to aggregate the documentation comments from multiple scripts into some standalone documentation file such as README?

Furthermore, is it possible to aggregate them in some markup format such as Markdown?


1 Answer 1


I would highly recommend looking into Epydoc and also Sphinx-Doc.

Epydoc especially does exactly what you are asking for as stated on their website and as per my experience working with it:

Epydoc is a tool for generating API documentation for Python modules, based on their docstrings.


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.