Selection of the members to document

This extension decides which members Sphinx includes in the reference manual, and optionally reports the nested classes whose pickling is broken.

sage_docbuild.ext.members.check_nested_class_picklability(app, what, name, obj, skip, options)

Print a warning if pickling is broken for nested classes.

sage_docbuild.ext.members.setup(app)

Register this extension with Sphinx.

sage_docbuild.ext.members.skip_member(app, what, name, obj, skip, options)

To suppress Sphinx warnings / errors, we

• Don’t include [aliases of] builtins.

• Don’t include the docstring for any nested class which has been inserted into its module by sage.misc.nested_class.NestedClassMetaclass only for pickling. The class will be properly documented inside its surrounding class.

• Optionally, check whether pickling is broken for nested classes.

• Optionally, include objects whose name begins with an underscore (‘_’), i.e., “private” or “hidden” attributes, methods, etc.

Otherwise, we abide by Sphinx’s decision. Note: The object obj is excluded (included) if this handler returns True (False).