Issues

Issue #1456 resolved

apidoc: Add a -M option to put module documentation before submodule documentation

Wes Turner
created an issue

For some use cases, depth-first display in API documentation makes sense. The code paths are:

Module
-> Submodule
-> Submodule

So it makes sense to have the generated documentation be

Module
-> Submodule
-> Submodule

Whereas currently, apidoc generated documentation pages are:

-> Submodule
-> Submodule
Module

Patch by Luc Saffre originally described here: https://groups.google.com/forum/#!topic/sphinx-users/Bm4w7OQcWYM

  • Omits the 'Module contents' heading (which seems implicit)
  • Puts 'master_package' documentation in the page header

Comments (11)

  1. Log in to comment