Martin Hans schrieb:
> Hi,
> we are considering switching our project to Sphinx.
>
> Our old documentation system supports creating different manuals from
> the same sources. We use this to build both a developer's API
> documentation and a user's manual (which only contain the publicly
> exported methods and classes).
>
> I have attached a patch which adds another event to autodoc such that
> the user can decide which module and class members should be included in
> the documentation.
>
> An example:
>
> def exdoc_decide_skip(app, what, name, obj, skip, options):
> # if the api_level of the object is below the module that we are
> running for
> # then skip it
> if getattr(obj, '_exdoc_api', 0) < app.config['api_level']:
> return True
> return skip
>
> and then somewhere else:
>
> app.connect('autodoc-member-decide-skip', exdoc_decide_skip)
> app.add_config_value('api_level', 2, True)
>
> We then have a decorator which sets the _exdoc_api attribute to 2 on the
> methods which we want in the user documentation.
>
>
> If you like the idea, it would be great to see my patch included in Sphinx.
This is a good idea! I'd like to include your patch, but the attachment seems
to have been mangled on the way. Can you send it to me directly?
Thanks,
Georg
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
