HomePhabricator

Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python…

Authored by teemperor on Jan 15 2021, 4:24 AM.

Description

Reland [lldb][docs] Use sphinx instead of epydoc to generate LLDB's Python reference

The build server should now have the missing dependencies.

Original summary:

Currently LLDB uses epydoc to generate the Python API reference for the website.
epydoc however is unmaintained since more than a decade and no longer works with
Python 3. Also whatever setup we had once for generating the documentation on
the website server no longer seems to work, so the current website documentation
has been stale since more than a year.

This patch replaces epydoc with sphinx and its automodapi plugin that can
generate Python API references. LLVM already uses sphinx for the rest of the
documentation, so this way we are more consistent with the rest of LLVM. The
only new dependency is the automodapi plugin for sphinx.

This patch effectively does the following things:

  • Remove the epydoc code.
  • Make a new dummy Python API page in our website that just calls the Sphinx command for generated the API documentation.
  • Add a mock _lldb module that is only used when generating the Python API. This way we don't have to build all of LLDB to generate the API reference.

Some notes:

  • The long list of skips is necessary due to boilerplate functions that SWIG is generating. Sadly automodapi is not really scriptable from what I can see, so we have to blacklist this stuff manually.
  • The .gitignore change because automodapi wants a subfolder of our documentation directory to place generated documentation files there. The path is also what is used on the website, so we can't really workaround this (without copying the whole docs dir somewhere else when we build).
  • We have to use environment variables to pass our build path to our sphinx configuration. Sphinx doesn't support passing variables onto that script.

Reviewed By: JDevlieghere

Differential Revision: https://reviews.llvm.org/D94489

Details