From 656e5dbbc7678f90f172eaa38d9b84109137257f Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Tue, 7 Apr 2020 11:40:39 +0200
Subject: [PATCH] [templates/doc/conf.py] Since sphinx 2.x, no need to avoid
private functions anymore. Everything is respected adequately
---
bob/devtools/templates/doc/conf.py | 22 ----------------------
1 file changed, 22 deletions(-)
diff --git a/bob/devtools/templates/doc/conf.py b/bob/devtools/templates/doc/conf.py
index 1545f416..a528ccaf 100644
--- a/bob/devtools/templates/doc/conf.py
+++ b/bob/devtools/templates/doc/conf.py
@@ -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)
--
GitLab