On Wed, Jan 27, 2010 at 3:53 AM, Robert Cimrman cimr...@ntc.zcu.cz wrote:
Logan Sorenson wrote:
Hi,
On Tue, Jan 26, 2010 at 2:53 AM, Robert Cimrman cimr...@ntc.zcu.cz wrote:
Hi Logan,
Logan Sorenson wrote:
Hi Robert,
On Mon, Jan 25, 2010 at 12:11 PM, Robert Cimrman cimr...@ntc.zcu.cz wrote:
One more thing: I would change a bit (again) the naming of the rst files corresponding to python source files. Since the rst files are now placed in the same directory structure as the sources, is there any reason for having the module paths encoded in the filenames?
Example rename: src/sfepy/terms/module_sfepy_terms_terms_hyperelastic_tl -> src/sfepy/terms/module_term_hyperelastic_tl
Yeah, this is a good idea; I think those names as a holdover from when all the files were in the same directory. :) Would we want to strip the module prefix as well?
+1, let's strip it as well. I will be able to do it at first tomorrow, let me know if you are faster :)
I don't know if I was faster...but it's at [6]. :) I also added an example for termsLinElasticity with the full inheritance options just to see what it looks like. I played some more with the autosummary but I think we would have to do a lot of manual maintenance to get the same format as with numpydoc. Maybe we should ask the numpydoc guys if there's a way to selectively turn on and off class method tables.
Yes, you were :) So, with "numpydoc_show_class_members = False" we would have to write something like
.. automodule:: sfepy.terms.termsLinElasticity :members: :undoc-members: :inherited-members: :show-inheritance:
instead of
.. automodule:: sfepy.terms.termsLinElasticity :members: :undoc-members:
for all the modules/classes where we would wish the full output with class members? It does not look that bad - just two more lines at the module level. But we would have to do it for all the modules, so yes, it might good idea to ask the numpydoc guys if there is an easier way.
Yes, although it seems like numpydoc uses some scripting magic to generate the class methods table right after the class docstring so I'm not quite sure how to match their format and ease of use in pure sphinx. I'll ask them if it's possible to add an attribute to control that feature at the per module and per class level.
As for the renaming, I guess you used some script or bash magic right? :) It worked well in general, but I prepared some traps by having underscores in several module names:
rename from doc/src/sfepy/terms/module_sfepy_terms_terms_hyperelastic_ul.rst rename to doc/src/sfepy/terms/ul.rst
should be rename to doc/src/sfepy/terms/hyperelastic_ul.rst
Ah, you caught me here! :) I just used a regex with the rename command, so it looks like I didn't consider this case...do you want me to correct it or have you done so already?
Best, 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 [4] http://thread.gmane.org/gmane.comp.python.numeric.general/33797 [5] http://code.google.com/p/pydocweb/issues/detail?id=50&can=1&colspec=ID%20Type%20Status%20Severity%20Milestone%20Owner%20Summary%20Opened [6] http://github.com/logansorenson/sfepy_doc2