Changeset 13469 for main/waeup.kofa/trunk/docs

Timestamp:

17 Nov 2015, 11:53:34 (9 years ago)

Author:

uli

Message:

Add autodoc member filter.

The added filter skips members with dots in their name.

This is a temporary solution (and a workaround) that allows to get rid
of the dependency on the self-baked Sphinx version we maintain.

We will turn this filter into an option of waeup.sphinx.autodoc (a
more elegant workaround).

Hopefully, as a third step, we will get our self-baked Sphinx changes
into the base Sphinx package. That would be a solution and not a
workaround any more.

File:

• main/waeup.kofa/trunk/docs/source/conf.py (modified) (1 diff)

main/waeup.kofa/trunk/docs/source/conf.py

@@ -213 +213 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
+
+
+def autodoc_skip_dotnamed_members(app, what, name, obj, skip, optios):
+    """In autodoc skip members with dot in name.
+
+    Sphinx chokes when it comes to objects that have dots in their name.
+
+    We will make this skipping an option of the then used
+    `waeup.sphinx.autodoc` package.
+
+    This is clearly a workaround and not a solution. This is a
+    workaround, not a solution.
+
+    In the long run our patch to Sphinx core will hopefully make it into
+    the Sphinx package itself. This would be a solution, not a
+    workaround.
+    """
+    if "." in name:
+        ##  Uncomment the following line to see what is skipped.
+        # print("SKIPPING %r %r %r" % (what, name, obj))
+        return True
+    return False
+
+def setup(app):
+    app.connect('autodoc-skip-member', autodoc_skip_dotnamed_members)