storax / jinjaapidoc

Sphinx API Doc with Jinja2 Templates
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

[Feature] Generate docs for the "public API" using __all__ #8

Closed AWhetter closed 8 years ago

AWhetter commented 8 years ago

If an init.py file contains an __all__ array, I think it should document those attributes on that module. There could even be an option to not document that attribute in it's full path. eg If pkg1's init.py file contains an all with pkg1.pkg2.pkg3.MyClass, MyClass should get documented on pkg1, and optionally not on pkg1.pkg2.pkg3.

Does this sound like a reasonable idea?