Skip to content
Snippets Groups Projects
Commit 656e5dbb authored by André Anjos's avatar André Anjos :speech_balloon:
Browse files

[templates/doc/conf.py] Since sphinx 2.x, no need to avoid private functions...

[templates/doc/conf.py] Since sphinx 2.x, no need to avoid private functions anymore.  Everything is respected adequately
parent 3bfa0418
No related branches found
No related tags found
1 merge request!151Remove custom patch to Sphinx doc generation to avoid private members
Pipeline #38779 passed
......@@ -234,25 +234,3 @@ if os.path.exists(sphinx_requirements):
)
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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment