Issues

Issue #1219 resolved

sphinx-apidoc includes special and private modules by default

Christopher 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 (2)

  1. Log in to comment