That''s a great topic. I've been using Sphinx to document a VHDL project
for FPGAs, which isn't really Python based at all. One thing it's missing
is the ability to distribute the rst source files around a project tree, I
think you can only create the toc relative to the current directory. I end
up copying them into the source folder as part of the conf.py execution. I
like the idea of having module level documents distributed with design
submodules, to lower the barrier for actually editing documentation and
keeping it up to date. You could also then take that module with it's
documentation and use it somewhere else.
I've found that Eclipse is pretty nice for editing the doc files, it gives
you a hierarchy view and lets you move the heading levels around with some
Sorry I can't make it tonight, but have a great meeting.
On Wed, Oct 3, 2012 at 6:00 PM, Mike Birdsall <mgbirds...
> The October meeting is tomorrow night, Thursday October 4th at 7pm at
> Washtenaw Community College in Room BE 240. Information, maps, directions,
> are all available at http://michipug.wordpress.com/
> The topic for the meeting is Sphinx, a documentation generator written in
> Python and used to generate the Python documentation.
> Web Site http://michipug.wordpress.com
> You received this message because you are subscribed to the Google Groups
> "Michigan Python Users Group" group.
> To post to this group, send email to firstname.lastname@example.org.
> To unsubscribe from this group, send email to
> Visit this group at http://groups.google.com/group/michipug?hl=en.