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 I could try to write a program to parse the JavaDocs but I don't think I could write it quickly enough for my current deadline. So copy/paste will have to do for now, I suppose. Not sure what you mean by "run it through an indent tool", though. Thanks, Chris On Thu, Feb 25, 2010 at 1:39 AM, Roger Binns <rog...@rogerbinns.com> wrote: > -----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 constants. > > Since I stick to a particular coding style and naming convention it is > relatively trivial to have a script do the parsing and dump the results > into > rst for Sphinx to pickup. > > If your Java is all consistently formatted then a similar script should be > relatively simple. Alternatively you could run it through some sort of > indent tool. > > Roger > -----BEGIN PGP SIGNATURE----- > Version: GnuPG v1.4.9 (GNU/Linux) > Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org > > iEYEARECAAYFAkuGGwUACgkQmOOfHg372QShhgCfZciY/W/p3Vkj8zOGGwWZmYKo > nIgAoN7ojZz++tZ6hrQ6keOJc8N14vWH > =Er5h > -----END PGP SIGNATURE----- > > -- > You received this message because you are subscribed to the Google Groups > "sphinx-dev" group. > To post to this group, send email to sphinx-...@googlegroups.com. > To unsubscribe from this group, send email to > sphinx-dev+unsubscr...@googlegroups.com<sphinx-dev%2bunsubscr...@googlegroups.com> > . > For more options, visit this group at > http://groups.google.com/group/sphinx-dev?hl=en. > > -- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-...@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
