current community

your communities

more stack exchange communities

Stack Exchange Inbox Reputation and Badges
tour help
Sign up ×
Programmers Stack Exchange is a question and answer site for professional programmers interested in conceptual questions about software development. It's 100% free.
up vote 0 down vote favorite

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?

Thanks.

share|improve this question

1 Answer 1

up vote 2 down vote

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.

share|improve this answer
    
In my experience, Sphinx tends to be much more commonly used and can pull docs from docstrings as well using the autodoc feature (sphinx-doc.org/ext/autodoc.html). –  Demian Brecht Mar 19 at 18:15

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

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