Could pybindgen migrate to use Sphinx for documentation generation?

There was a weekend a while back when I sat down and decided to give it a go, i.e. convert the docs to Sphinx. But then I found this in the Sphinx documentation which made me give up:

"""
The focus is on hand-written documentation, rather than auto-generated API docs. Though there is limited support for that kind of docs as well (which is intended to be freely mixed with hand-written content), if you need pure API docs have a look at Epydoc, which also understands reST.
"""
source: http://sphinx.pocoo.org/intro.html#introduction

So, for API docs the Sphinx documentation itself points to epydoc! Nevertheless, I see lots of projects with API docs using Sphinx, so I am confused.

Feel free to investigate further. I am receptive to switching to Sphinx if it makes sense. I am only just not sure if it does make sense...

Hey Gustavo

Yeah, it is confusing, but don't worry, you can do what you want. You have to enable the autodoc module and have some files which define which parts of the API to document. Overall its worth the effort I think.

Also, I notice there are a fair few "examples" in your top-level header: these could be extracted out into a seperate documentation file which might perhaps make them clearer and easier to manage?

Let me know what you think...as I say, I can have a look at doing this one night in front of the TV maybe :)

Jamie

Heh, sounds like your TV programs suck as much as mine :-)
Go for it. Your effort will most likely not be in vain. I am going to create a bug report from this.