Hello,

We are using the autosummary directive to document the contents of a module 
[1].  Among the module contents is a class that contains some members (for 
example [2]) that should not be documented.  (Their purpose is to catch a 
common user error and provide a useful message.)

It seems that we could use the :exclude-members: option with autoclass, but 
if I am not mistaken that would require stopping to use autosummary for 
module [1] and adding a bunch of files explicitly that were previously 
generated by autosummary.  That's quite a lot of boilerplate.  Is there a 
better solution?

Thanks,
Christoph

[1] https://kwant-project.org/doc/1/reference/kwant.builder
[2] 
https://kwant-project.org/doc/1/reference/generated/kwant.builder.Builder#kwant.builder.Builder.modes

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.

Reply via email to