diff options
author | Med Ismail Bennani <ismail@bennani.ma> | 2023-08-31 20:34:56 +0100 |
---|---|---|
committer | Med Ismail Bennani <ismail@bennani.ma> | 2023-08-31 20:35:10 +0100 |
commit | 6813ef37377e8d8fadf6efe01e1ed80cc53b9c86 (patch) | |
tree | ec78789e9c73e18684266e0a019e42a8d472a2f3 /lldb/docs | |
parent | b80fa58bdc54d80d7482549f9d17106c6f544a16 (diff) | |
download | llvm-6813ef37377e8d8fadf6efe01e1ed80cc53b9c86.zip llvm-6813ef37377e8d8fadf6efe01e1ed80cc53b9c86.tar.gz llvm-6813ef37377e8d8fadf6efe01e1ed80cc53b9c86.tar.bz2 |
Re-land "[lldb/docs] Silence warnings when generating website"
This patch re-lands f0731d5b61ba with more fixes and improvements.
First, this patch removes `__eq__` implementations from classes that
didn't implemented `operator!=` on the C++ implementation.
This patch removes sphinx document generation for special members such
as `__len__`, since there is no straightforward way to skip class that
don't implement them. We also don't want to introduce a change in
behavior by implementing artifical special members for classes that are
missing them.
Finally, this patch improve the ergonomics of some classes by
implementing special members where it makes sense, i.e. `hex(SBFrame)`
is equivalent to `SBFrame.GetPC()`.
Differential Revision: https://reviews.llvm.org/D159017
Signed-off-by: Med Ismail Bennani <ismail@bennani.ma>
Diffstat (limited to 'lldb/docs')
-rw-r--r-- | lldb/docs/conf.py | 4 | ||||
-rw-r--r-- | lldb/docs/python_api.rst | 86 |
2 files changed, 3 insertions, 87 deletions
diff --git a/lldb/docs/conf.py b/lldb/docs/conf.py index c5b89d6..730a860 100644 --- a/lldb/docs/conf.py +++ b/lldb/docs/conf.py @@ -43,7 +43,7 @@ automodapi_toctreedirnm = "python_api" extensions = ["sphinx.ext.todo", "sphinx.ext.mathjax", "sphinx.ext.intersphinx"] autodoc_default_options = { - "special-members": "__int__, __len__, __hex__, __oct__, __iter__", + "special-members": True } # Unless we only generate the basic manpage we need the plugin for generating @@ -170,7 +170,7 @@ html_title = "🐛 LLDB" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] +# html_static_path = ["_static"] html_extra_path = [".htaccess"] diff --git a/lldb/docs/python_api.rst b/lldb/docs/python_api.rst index 5e465e1..6a95b36 100644 --- a/lldb/docs/python_api.rst +++ b/lldb/docs/python_api.rst @@ -5,94 +5,10 @@ LLDB Python API The long list of "skip" filters out several global functions that are generated by SWIG (but which are not useful as they are only the backend for their respective static functions in the classes). - Without this list .. automodapi:: lldb :no-inheritance-diagram: - :skip: SBBreakpoint_EventIsBreakpointEvent - :skip: SBBreakpoint_GetBreakpointEventTypeFromEvent - :skip: SBBreakpoint_GetBreakpointFromEvent - :skip: SBBreakpoint_GetBreakpointLocationAtIndexFromEvent - :skip: SBBreakpoint_GetNumBreakpointLocationsFromEvent - :skip: SBCommandInterpreter_EventIsCommandInterpreterEvent - :skip: SBCommandInterpreter_GetArgumentDescriptionAsCString - :skip: SBCommandInterpreter_GetArgumentTypeAsCString - :skip: SBCommandInterpreter_GetBroadcasterClass - :skip: SBCommunication_GetBroadcasterClass - :skip: SBData_CreateDataFromCString - :skip: SBData_CreateDataFromDoubleArray - :skip: SBData_CreateDataFromSInt32Array - :skip: SBData_CreateDataFromSInt64Array - :skip: SBData_CreateDataFromUInt32Array - :skip: SBData_CreateDataFromUInt64Array - :skip: SBDebugger_Create - :skip: SBDebugger_Create - :skip: SBDebugger_Destroy - :skip: SBDebugger_FindDebuggerWithID - :skip: SBDebugger_GetBuildConfiguration - :skip: SBDebugger_GetDefaultArchitecture - :skip: SBDebugger_GetInternalVariableValue - :skip: SBDebugger_GetVersionString - :skip: SBDebugger_Initialize - :skip: SBDebugger_InitializeWithErrorHandling - :skip: SBDebugger_MemoryPressureDetected - :skip: SBDebugger_SetDefaultArchitecture - :skip: SBDebugger_SetInternalVariable - :skip: SBDebugger_StateAsCString - :skip: SBDebugger_StateIsRunningState - :skip: SBDebugger_StateIsStoppedState - :skip: SBDebugger_Terminate - :skip: SBEvent_GetCStringFromEvent - :skip: SBFileSpec_ResolvePath - :skip: SBFile_MakeBorrowed - :skip: SBFile_MakeBorrowedForcingIOMethods - :skip: SBFile_MakeForcingIOMethods - :skip: SBHostOS_GetLLDBPath - :skip: SBHostOS_GetLLDBPythonPath - :skip: SBHostOS_GetProgramFileSpec - :skip: SBHostOS_GetUserHomeDirectory - :skip: SBHostOS_ThreadCancel - :skip: SBHostOS_ThreadCreate - :skip: SBHostOS_ThreadCreated - :skip: SBHostOS_ThreadDetach - :skip: SBHostOS_ThreadJoin - :skip: SBLanguageRuntime_GetLanguageTypeFromString - :skip: SBLanguageRuntime_GetNameForLanguageType - :skip: SBModuleSpecList_GetModuleSpecifications - :skip: SBModule_GarbageCollectAllocatedModules - :skip: SBModule_GetNumberAllocatedModules - :skip: SBPlatform_GetHostPlatform - :skip: SBProcess_EventIsProcessEvent - :skip: SBProcess_EventIsStructuredDataEvent - :skip: SBProcess_GetBroadcasterClassName - :skip: SBProcess_GetInterruptedFromEvent - :skip: SBProcess_GetNumRestartedReasonsFromEvent - :skip: SBProcess_GetProcessFromEvent - :skip: SBProcess_GetRestartedFromEvent - :skip: SBProcess_GetRestartedReasonAtIndexFromEvent - :skip: SBProcess_GetStateFromEvent - :skip: SBProcess_GetStructuredDataFromEvent - :skip: SBReproducer_Capture - :skip: SBReproducer_PassiveReplay - :skip: SBReproducer_SetAutoGenerate - :skip: SBReproducer_SetWorkingDirectory - :skip: SBTarget_EventIsTargetEvent - :skip: SBTarget_GetBroadcasterClassName - :skip: SBTarget_GetModuleAtIndexFromEvent - :skip: SBTarget_GetNumModulesFromEvent - :skip: SBTarget_GetTargetFromEvent - :skip: SBThread_EventIsThreadEvent - :skip: SBThread_GetBroadcasterClassName - :skip: SBThread_GetStackFrameFromEvent - :skip: SBThread_GetThreadFromEvent - :skip: SBTypeSummary_CreateWithFunctionName - :skip: SBTypeSummary_CreateWithScriptCode - :skip: SBTypeSummary_CreateWithSummaryString - :skip: SBTypeSynthetic_CreateWithClassName - :skip: SBTypeSynthetic_CreateWithScriptCode - :skip: SBWatchpoint_EventIsWatchpointEvent - :skip: SBWatchpoint_GetWatchpointEventTypeFromEvent - :skip: SBWatchpoint_GetWatchpointFromEvent :skip: command + :skip: declaration :skip: in_range :skip: is_numeric_type :skip: lldb_iter |