1. Georg Brandl
  2. sphinx
  3. Pull requests

Pull requests

#161 Merged
Repository
sphinx-fork-dcmouser
Branch
default
Repository
sphinx
Branch
default

Added option to apidoc to write each module to standalone page instead of combining all modules in a package on one page.

Author
  1. Jesse Reichler
Reviewers
Description

The sphinx-apidoc tool scans source code directories and creates rst files, in order to assist in generating automatic documentation of source code.

When it finds a package (directory) of modules (.py files) it creates a single rst file for the package, which contains the documentation for every module (.py file) in the package (directory). This can result in an exceedingly long page (with anchors for each module) that can be hard to browse.

This small change to apidoc adds a new option (--separate) which, when enabled, creates a separate page for each module in a package. This makes source code documentation much easier to browse and read in my opinion.

When the new option is not specified, apidoc behaves exactly as before.

Updated pull request to include change to apidoc documentation and removed personal comments in code to conform to existing codebase better.

  • Learn about pull requests

Comments (4)