diff --git a/bob/devtools/scripts/sphinx.py b/bob/devtools/scripts/sphinx.py
new file mode 100644
index 0000000000000000000000000000000000000000..8aba8823da891a54ef7bf0aeb0787f2e9aa05615
--- /dev/null
+++ b/bob/devtools/scripts/sphinx.py
@@ -0,0 +1,198 @@
+import click
+
+
+@click.group()
+def sphinx():
+ pass
+
+
+@sphinx.command()
+@click.argument(
+ "sphix_configurations",
+ type=click.Path(exists=True, dir_okay=False),
+ required=False,
+ nargs=-1,
+)
+def migrate_autodoc_flags(sphix_configurations):
+ if not sphix_configurations:
+ sphix_configurations = ["doc/conf.py"]
+ for sphinx_config in sphix_configurations:
+ with open(sphinx_config) as f:
+ config = f.read()
+
+ config = config.replace(
+ """autodoc_default_flags = [
+ 'members',
+ 'undoc-members',
+ 'show-inheritance',
+ ]""",
+ """autodoc_default_options = {
+ "members": True,
+ "undoc-members": True,
+ "show-inheritance": True,
+}""",
+ )
+
+ # another variant
+ config = config.replace(
+ """autodoc_default_flags = [
+ "members",
+ "undoc-members",
+ "show-inheritance",
+]""",
+ """autodoc_default_options = {
+ "members": True,
+ "undoc-members": True,
+ "show-inheritance": True,
+}""",
+ )
+
+ # another variant
+ config = config.replace(
+ """autodoc_default_flags = [
+ 'members',
+ 'undoc-members',
+ 'show-inheritance',
+]""",
+ """autodoc_default_options = {
+ "members": True,
+ "undoc-members": True,
+ "show-inheritance": True,
+}""",
+ )
+
+ # another variant
+ config = config.replace(
+ """autodoc_default_flags = [
+ 'members',
+ 'undoc-members',
+ 'inherited-members',
+ 'show-inheritance',
+ ]""",
+ """autodoc_default_options = {
+ "members": True,
+ "undoc-members": True,
+ "inherited-members": True,
+ "show-inheritance": True,
+}""",
+ )
+
+ # another variant
+ config = config.replace(
+ """autodoc_default_flags = ["members", "undoc-members", "show-inheritance"]""",
+ """autodoc_default_options = {
+ "members": True,
+ "undoc-members": True,
+ "show-inheritance": True,
+}""",
+ )
+
+ config = config.replace(
+ """# 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)
+""",
+ "",
+ )
+
+ # another variant
+ config = config.replace(
+ """# 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)
+""",
+ "",
+ )
+
+ # another variant
+ config = config.replace(
+ """# 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)
+""",
+ "",
+ )
+
+ # another variant
+ config = config.replace(
+ """
+# 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)
+""",
+ "",
+ )
+
+ with open(sphinx_config, "w") as f:
+ f.write(config)
diff --git a/bob/devtools/templates/doc/conf.py b/bob/devtools/templates/doc/conf.py
index 6ee3d7a8fa5886ea6d7686999ac9b3bcec40d5bb..7844df4ad2c0a48d2dc94f3435b2acd8809fba8c 100644
--- a/bob/devtools/templates/doc/conf.py
+++ b/bob/devtools/templates/doc/conf.py
@@ -223,7 +223,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,
+}
sphinx_requirements = "extra-intersphinx.txt"
diff --git a/conda/meta.yaml b/conda/meta.yaml
index af0b71ceda49d45b9231e21a33db9bc20dc885ef..de3486a1117e61922a781a54643acf52f7edeb89 100644
--- a/conda/meta.yaml
+++ b/conda/meta.yaml
@@ -107,6 +107,8 @@ test:
- bdt gitlab get-pipelines --help
- bdt gitlab graph --help
- bdt gitlab badges --help
+ - bdt sphinx --help
+ - bdt sphinx migrate-autodoc-flags --help
- sphinx-build -aEW ${PREFIX}/share/doc/{{ name }}/doc sphinx
{% if not os.path.exists('sphinx') %}
- if [ -n "${CI_PROJECT_DIR}" ]; then mv sphinx "${CI_PROJECT_DIR}/"; fi
diff --git a/doc/conf.py b/doc/conf.py
index f30bb3d2de2a32a505af985f2d297bdfa5a151d3..e2d7899a429ca3d866194add0379c009e0affe68 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -221,11 +221,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,
+}
# Adds simplejson, pyzmq links
# intersphinx_mapping['http://simplejson.readthedocs.io/en/stable/'] = None
diff --git a/setup.py b/setup.py
index f22e6f62aecfc1b93cafa991570d2864c70a7532..5a9eb12b3628f7c762ee1a90aa3bda20920cf992 100644
--- a/setup.py
+++ b/setup.py
@@ -52,6 +52,7 @@ setup(
"dav = bob.devtools.scripts.dav:dav",
"local = bob.devtools.scripts.local:local",
"gitlab = bob.devtools.scripts.gitlab:gitlab",
+ "sphinx = bob.devtools.scripts.sphinx:sphinx",
],
"bdt.gitlab.cli": [
"badges = bob.devtools.scripts.badges:badges",