I'm going through and preparing the transforms.py documentation for our new Sphinx setup. One of the things that's really important to document is the class heirarchy, but Sphinx doesn't appear to do that. I've looked at the Sphinx documentation and nothing comes up. I thought I'd check with this list first to see if I'm just missing something. Otherwise, I thought I would address this with the Sphinx folks to see what they would suggest. I think this would also be useful to have in the "artists" api documentation. For example, right now it isn't explicit that Line2D inherits from Artist. We can, I suppose, implement some sort of standard to always put the base classes in the docstring, but it would be nice to automate that.
Cheers,
Mike
···
--
Michael Droettboom
Science Software Branch
Operations and Engineering Division
Space Telescope Science Institute
Operated by AURA for NASA
I think this would be worth asking about on sphinx-dev, it seems like an
important feature for the autodoc extension.
···
On Thursday 05 June 2008 08:19:47 am Michael Droettboom wrote:
I'm going through and preparing the transforms.py documentation for our
new Sphinx setup. One of the things that's really important to document
is the class heirarchy, but Sphinx doesn't appear to do that. I've
looked at the Sphinx documentation and nothing comes up. I thought I'd
check with this list first to see if I'm just missing something.
Otherwise, I thought I would address this with the Sphinx folks to see
what they would suggest. I think this would also be useful to have in
the "artists" api documentation. For example, right now it isn't
explicit that Line2D inherits from Artist. We can, I suppose, implement
some sort of standard to always put the base classes in the docstring,
but it would be nice to automate that.