llvm-project/lldb/docs
Raphael Isemann 3ebfeb2586 [lldb][docs] Force documentation emission of special Python class members
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

Reviewed By: JDevlieghere

Differential Revision: https://reviews.llvm.org/D105480
2021-07-07 19:49:50 +02:00
..
_lldb Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference 2021-01-17 12:13:01 +01:00
_static [lldb][docs] Expand CSS fix for LLDB doc tables 2021-01-20 10:30:00 +01:00
design [trace][intel-pt] Create basic SB API 2021-06-17 15:14:47 -07:00
man Fix typo, arvm7 -> armv7 2021-05-05 00:56:44 -04:00
resources [lldb] Fix typos. NFC. 2021-05-31 06:48:57 +07:00
status [lldb] Fix typos. NFC. 2021-05-31 06:48:57 +07:00
testsuite [lldb][NFC] Delete a checked-in build log in docs/testsuite 2021-04-23 10:36:43 +02:00
use [lldb][docs] Fix reference warnings in python-reference.rst 2021-07-06 10:14:33 +02:00
.htaccess [trace][intel-pt] Create basic SB API 2021-06-17 15:14:47 -07:00
CMakeLists.txt Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference 2021-01-17 12:13:01 +01:00
conf.py [lldb][docs] Force documentation emission of special Python class members 2021-07-07 19:49:50 +02:00
doxygen-mainpage.dox [Docs] Make Doxygen functional 2019-04-19 18:02:35 +00:00
doxygen.cfg.in [lldb] Fix typos in documentation (NFC) 2021-03-01 23:40:29 -08:00
index.rst [lldb] [docs] Update platform support status 2021-02-21 21:47:48 +01:00
lldb-for-gdb-users.txt [lldb] Fix typos in documentation (NFC) 2021-03-01 23:40:29 -08:00
lldb-gdb-remote.txt Add a corefile style option to process save-core; skinny corefiles 2021-06-20 12:26:54 -07:00
lldb-platform-packets.txt [lldb] Fix typos in documentation (NFC) 2021-03-01 23:40:29 -08:00
python_api.rst Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference 2021-01-17 12:13:01 +01:00
python_api_enums.rst [lldb][docs] Add the missing rst anchors to the Python enum docs 2021-06-14 16:31:28 +02:00