Hi Christoph, You have a couple of options:
1. If it is only the one function in one class, I would just let it be documented. 2. You could break out the builder into its own section and have 3 sections on the page to generate the stub files and then edit out the function unneeded in the builder.rst file. 3. You could try autodoc-skip-member (though I have not used it) http://www.sphinx-doc.org/en/stable/ext/autodoc.html#event-autodoc-skip-member If you can you may wish to update to a more recent version of sphinx too. Carol On Friday, May 18, 2018 at 2:41:37 PM UTC-7, chri...@grothesque.org wrote: > > 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 sphinx-users+unsubscr...@googlegroups.com. To post to this group, send email to sphinx-users@googlegroups.com. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
