Commit f1aab170 authored by Amir MOHAMMADI's avatar Amir MOHAMMADI

Sphinx 3 autodoc no longer accepts autodoc_default_flags and autodoc_default_options should be used

parent 9fa43aaf
Pipeline #46297 failed with stages
in 8 minutes and 29 seconds
...@@ -229,11 +229,11 @@ rst_epilog = """ ...@@ -229,11 +229,11 @@ rst_epilog = """
# Default processing flags for sphinx # Default processing flags for sphinx
autoclass_content = 'class' autoclass_content = 'class'
autodoc_member_order = 'bysource' autodoc_member_order = 'bysource'
autodoc_default_flags = [ autodoc_default_options = {
'members', "members": True,
'undoc-members', "undoc-members": True,
'show-inheritance', "show-inheritance": True,
] }
# For inter-documentation mapping: # For inter-documentation mapping:
from bob.extension.utils import link_documentation, load_requirements from bob.extension.utils import link_documentation, load_requirements
...@@ -247,22 +247,3 @@ else: ...@@ -247,22 +247,3 @@ else:
intersphinx_mapping = link_documentation() 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)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment