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

Raphael Isemann via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Jan 13 01:51:16 PST 2021


teemperor added a comment.

I merged the Python API now into the normal website (see https://teemperor.de/pub/lldb_website/python_api.html# for how this looks). So cross-referencing and the website search now work for everything.

The Python API will now just use the normal LLDB website theme and that looks actually pretty nice and seems consistent with the rest of the LLVM project's websites. It's not consistent with the way Clang and LLVM's *documentation pages* look, but those are also not consistent with the website look&feel.

I also moved the environment passing to LLVM's Sphinx CMake code (because otherwise we can't reuse all their boilerplate as we did before).



================
Comment at: .gitignore:67
+# automodapi generates temporary files here.
+/lldb/docs/python_api/api/
----------------
JDevlieghere wrote:
> teemperor wrote:
> > JDevlieghere wrote:
> > > Any way we can make sure this ends up in the build dir instead?
> > I could ask CMake to give us a relative path to some build subdir (apparently the sphinx plugin wants a relative path for some reason). But doing a relative path from source to build can end up causing some sketchy results (like, you can't do cross-drive relative paths on Windows and not sure what other weird situations can have non-functioning relative paths). We could also just see if we can sneak in an absolute path and maybe the sphinx plugin doesn't complain.
> Understood. Seems like it's not worth the hassle. 
So I tired to see what will happen with an absolute path (or a generated relative path), but it seems that 'relative path' here is actually both the URL on the final website and the path to the directory, i.e., `lldb.llvm.org/WHATEVER_PATH_WE_PASS/lldb.SBAddress.html`. It seems the plugin just throws some generated rst files in a subdirectory and Sphinx is doing the rest).


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D94489/new/

https://reviews.llvm.org/D94489



More information about the llvm-commits mailing list