Hi!

I have in variable "obj" the module, how can I initiate
ModuleDocumenter and use filter_members for my list of members?


Longer description:

(I'm working on inside function sphinx/ext/autosummary/generate.py
function generate_autosummary_docs, you really don't have to open
this)

I'm trying to improve autosummary extensions generate_autosummary_docs
function to be able to autodocument packages... Well it works, but it
is not very native to Sphinx begin with.

Autosummary *has custom filtering system* that *does not* use the
filter_members, and that is not very optimal, we already have this
great Documenter.filter_members!

For example currently in autosummary there is hard coded that __init__
should be documented. In fact it should not be hard coded and should
rely on filter_members() purely, so the user can create own callback
using `autodoc-skip-member` event.

But I have no idea how to initiate say for example ModuleDocumenter
and use it's filter_members to filter away members that user does not
want to be documented. Same for ClassDocumenter, etc... Ideally in
generate_autosummary_docs we should initiate all documenters and use
appropriate filter_members().
-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to [email protected].
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.


Reply via email to