docs: Exposing select dunder methods to Sphinx.

Author: amunra

TODO.rst

@@ -5,9 +5,9 @@ TODO
 
 Build Tooling
 =============
-* **[HIGH]** Integrate tooling to build binaries for a matrix of operating
-  systems, architectures and Python versions. This will also be our CI.
-  This should help: https://github.com/pypa/cibuildwheel
+* **[MEDIUM]** Transition to Azure, move Linux arm to ARM pipeline without QEMU.
+
+* **[MEDIUM]** Automate Apple Silicon.
 
 
 Docs
@@ -27,8 +27,6 @@ Docs
 
 Development
 ===========
-* **[HIGH]** Review API naming!
-
 * **[HIGH]** Implement the auto-commit logic based on a watermark.
 
 * **[MEDIUM]** Once we're done with them, merge in changes in the ``py_client_tweaks`` branch

docs/conf.py

@@ -49,3 +49,18 @@
 napoleon_use_ivar = True
 napoleon_use_rtype = False
 napoleon_use_param = False
+
+autodoc_default_options = {
+    'special-members': '__init__ , __str__ , __enter__ , __exit__',
+    'undoc-members': True
+}
+
+
+# def do_not_skip_dunder_members(_app, _what, name, _obj, would_skip, _options):
+#     if name in ('__init__', '__call__', '__str__', '__enter__', '__exit__'):
+#         return False
+#     return would_skip
+
+
+# def setup(app):
+#     app.connect('autodoc-skip-member', do_not_skip_dunder_members)