-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Am 27.02.2010 01:42, schrieb Roger Binns:
Chris Collins wrote:
Good idea. In case you're not familiar, Java has an automatic
documentation feature called JavaDoc.
I used Java from around its 1.0 days and consequently am very familiar with
Roger,
Good idea. In case you're not familiar, Java has an automatic documentation
feature called JavaDoc. Basically, you just put your documentation in your
source files and then run the doc tool and it generates a whole bunch of
nicely formatted HTML files with a consistent structure.
I guess
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Chris Collins wrote:
Good idea. In case you're not familiar, Java has an automatic
documentation feature called JavaDoc.
I used Java from around its 1.0 days and consequently am very familiar with
Javadoc. It was the first time a mainstream
The new domains feature in the upcoming 1.0 should be a good way forward,
assuming you can wait that long...
see: http://pythonic.pocoo.org/2009/9/12/new-in-sphinx-1-0-domains
and: http://pythonic.pocoo.org/2010/1/7/new-year-s-python-meme-and-status
Good luck!
Kevin Horn
On Tue, Feb 23, 2010
That confirms my suspicion that I just need to bite the bullet and copy and
paste my JavaDocs into some rst files.
Thankfully there will be an easier way in the future. Thanks for the links,
Kevin.
On Wed, Feb 24, 2010 at 11:05 AM, Kevin Horn kevin.h...@gmail.com wrote:
The new domains feature
Ouf! That defeats the idea of keeping code and doc comments in the same
place. You'll need to be vigilant to be sure the docs are kept up to date.
--Janet
On Wed, Feb 24, 2010 at 11:40 AM, Chris Collins xop...@gmail.com wrote:
That confirms my suspicion that I just need to bite the bullet and
Yes. Separating the Javadocs from the source code is definitely not the way
I wanted to go. But Sphinx remains my best possible solution for formatting
the document I am working on so I will try to make the best of it at this
point.
Indeed, I'm not sure now if I should use the autodoc command at
-BEGIN PGP SIGNED MESSAGE-
Hash: SHA1
Chris Collins wrote:
Yes. Separating the Javadocs from the source code is definitely not the
way I wanted to go.
I generate a whole bunch of my docs by parsing C source files - the docs are
actually about resulting Python visible functions and
