1. Georg Brandl
  2. sphinx
  3. Pull requests

Pull requests

#41 Declined
Repository
Deleted repository
Branch
default (bc7c6196331d)
Repository
sphinx
Branch
default

Tentative addition of recursive package autodocumentation

Author
  1. masklinn
Reviewers
Description

Nowhere near done (does not even pass the trivial testcase i added to the suite), but I'd like to know if this looks like a good direction, and if there's any suggestion/pointer:

  • Added a new optional parameter :recurse: to the automodule directive
  • When this option is encountered, set recurse to True on ModuleDocumenter right before documenting its members (and unset it after that) to drill down into sub-packages as well
  • Add submodules (and packages) to the package's get_objects_members and respond positively to can_document_member if recurse is set

Problems at this point:

 AssertionError: ['"::" in automodule name doesn\'t make sense']

one of those is left after screwing with resolve_name a bit, I'm not actually sure what I did to that method makes sense.

and the second level of autofodder (the test case package) does not get documented

  • Learn about pull requests

Comments (0)