sphinx-apidoc includes special and private modules by default

Christopher Wilson avatarChristopher Wilson created an issue

All files in the following example package will be included by sphinx-apidoc regardless of whether 'private-members' and 'special-members' have been specified in SPHINX_APIDOC_OPTIONS.

package/
    __init__.py
    _private.py
    __special__.py
    public.py

Is this intended behavior? If so, is there a way to instruct sphinx-apidoc to ignore private and special modules in a package?

I've attached a patch that modifies the shall_skip function to check whether 'private-members' and 'special-members' have been explicitly specified before including private or special modules respectively.

Comments (1)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.