Hi Robert,
On Mon, Jan 25, 2010 at 4:40 AM, Robert Cimrman cimr...@ntc.zcu.cz wrote:
Hi,
At [1] you can see the basic sphinx documentation of the terms (scroll down). It took me some time to convert the docstrings, but the result is not bad. The new sources are for the moment at [2], I will push it to the master repo after I get some feedback.
Wow, it looks really nice! Also, it looks like it is easy to add the description (including latex) into docstring of the respective term class.
I do not know yet how to hide the common methods of the terms, i.e. do the following split:
- The Term class documentation with all the common methods
- The Term subclass documentation with only Description, Definition, and possibly the extra methods not already defined by Term.
I guess we can just double the .rst files: one set for the full description (1.) and one with the summary (2.). I think for set (2.) we could take :undoc-members: out of the .rst sources and specify manually which members to document, e.g., from [3]:
.. autoclass:: Noodle :members: eat, slurp
where autoclass is automodule in our case. Or we could probably also work on the class level. I haven't had time to test the above yet, but hopefully it works! :)
After this is done, we could happily abandon the old way of generating the sfepy_manual.pdf (which is broken now anyway, as the docstrings changed).
Awesome!
Logan
[1] http://rc.github.com/sfepy/developer_guide.html [2] http://github.com/rc/sfepy [3] http://sphinx.pocoo.org/ext/autodoc.html#dir-automodule