diff --git a/doc/conf.py b/doc/conf.py index f35f7813dd8ced2bc099682c93472fac22da56f2..9a147ebd5942e50dc492307c4c2f7dafabe49450 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -222,11 +222,11 @@ rst_epilog = """ # Default processing flags for sphinx autoclass_content = 'class' autodoc_member_order = 'bysource' -autodoc_default_flags = [ - 'members', - 'undoc-members', - 'show-inheritance', - ] +autodoc_default_options = { + "members": True, + "undoc-members": True, + "show-inheritance": True, +} # For inter-documentation mapping: from bob.extension.utils import link_documentation, load_requirements @@ -237,22 +237,3 @@ else: intersphinx_mapping = link_documentation() -# We want to remove all private (i.e. _. or __.__) members -# that are not in the list of accepted functions -accepted_private_functions = ['__array__'] - -def member_function_test(app, what, name, obj, skip, options): - # test if we have a private function - if len(name) > 1 and name[0] == '_': - # test if this private function should be allowed - if name not in accepted_private_functions: - # omit privat functions that are not in the list of accepted private functions - return skip - else: - # test if the method is documented - if not hasattr(obj, '__doc__') or not obj.__doc__: - return skip - return False - -def setup(app): - app.connect('autodoc-skip-member', member_function_test)