Page MenuHomePhabricator

[Docs] Make it possible to generate the python reference without building all of LLDB
ClosedPublic

Authored by JDevlieghere on Apr 26 2019, 4:28 PM.

Details

Summary

As discussed on the mailing list, we should be able to generate the Python reference without building all of LLDB. To make that possible I create a dummy python package, which is then parsed by epydoc. The latter will complain that it couldn't import lldb, but that doesn't matter as far as generation of the docs is concerned.

Diff Detail

Repository
rL LLVM

Event Timeline

JDevlieghere created this revision.Apr 26 2019, 4:28 PM
labath accepted this revision.Apr 29 2019, 3:47 AM

Looks good to me. Thanks for looking into this.

On one hand, it would be nice to create avoid creating the fake package, and just run epydoc from the final destination, but on the other, the nice thing about this is that it will always run in the same environment and not depend on whether you happen to have _lldb.so built or not (plus, with all the complexity around frameworks and stuff, it might be hard to get __init__.py to be placed in the final destination without depending on any of the other build steps).

This revision is now accepted and ready to land.Apr 29 2019, 3:47 AM
This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptApr 29 2019, 9:27 AM