Commit 9fe2e8ba 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 7464d206
Pipeline #45269 failed with stage
in 36 minutes and 48 seconds
......@@ -260,7 +260,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,
}
if "BOB_DOCUMENTATION_SERVER" not in os.environ:
# notice we need to overwrite this for BEAT projects - defaults from Bob are
......@@ -282,26 +286,3 @@ intersphinx_mapping["http://simplejson.readthedocs.io/en/stable/"] = None
intersphinx_mapping["http://pyzmq.readthedocs.io/en/stable/"] = None
intersphinx_mapping["http://python-jsonschema.readthedocs.io/en/stable/"] = None
intersphinx_mapping["https://docker-py.readthedocs.io/en/stable/"] = None
# 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 private 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