Easily extendable autodoc

[shimizukawa]

Make autodoc directives easily extendable, as proposed in

http://groups.google.com/group/sphinx-dev/browse_thread/thread/7845240128b3b48a/5d7bc99598699710?lnk=gst&q=autodoc#5d7bc99598699710

[comment from OP]

I'd like to retract my proposition, or rather rephrase it.

Extending autodoc would be simpler if directives such as function, class, method were
defined as classes rather than in the desc_directive function.

Something like:

class Description(Directive):

   def __init__
   def handle_options
   def handle_signature
   def handle_content
   def handle_field_list
   def index_as
   def run

Extending autodoc would then simply be a matter of subclassing those directive. I
used this approach to write directives to autodocument fortran code (fortrandoc on
launchpad) and I found it worked well.

---

• Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/3
• Originally reported by: Georg Brandl
• Originally created at: 2008-11-02T22:14:37.704

[shimizukawa]

From Georg Brandl on 2009-01-04 20:03:59+00:00

When we switch to docutils 0.5 only as a dependency is a good occasion to do this.

[shimizukawa]

From Georg Brandl on 2009-02-20 09:35:41+00:00

Now implemented in trunk (even without requiring docutils 0.5).

[shimizukawa]

From Georg Brandl on 2010-08-25 12:19:56+00:00

Removing milestone: 0.6 (automated comment)