[lldb][docs] Force documentation emission of special Python class members

[teemperor]

Summary

The current LLDB Python docs are missing documentation for all the special members such as
conversion functions (__int__) and other special functions (__len__).

The reason for that is that the automodapi plugin we're using to generate the *.rst files simply
doesn't emit them. There doesn't seem to be any config option to enable those in automodapi
and it's not even clear why they are filtered. I assume the leading underscore in their names
makes them look like private methods.

This patch just forcibly adds a few selected special members functions to the list of functions
that sphinx should always document. This will cause sphinx to warn if a class doesn't have one of those
functions but it's better than not having them documented.

The main motivation here is that since SBAddress.__int__ is one of the few functions that is
only available in the embedded Python REPL which would be good to have in the public documentation.

Fixes rdar://64647665

[teemperor]

I think the proper fix here is to send a patch to the automodapi folks, but that will take a while...

[JDevlieghere]

LGTM. 🚢 it.

lldb/docs/conf.py

 
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.todo', 'sphinx.ext.mathjax', 'sphinx.ext.intersphinx']
 
+autodoc_default_options = {
+    'special-members': '__int__, __len__, __hex__, __oct__, __iter__',
+}
+
 # Unless we only generate the basic manpage we need the plugin for generating
 # the Python API documentation.
 if not building_man_page:
     extensions.append('sphinx_automodapi.automodapi')
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']