Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Autosummary: Extend __all__ members to template rendering #10811

Merged
merged 7 commits into from Apr 5, 2023

Commits on Apr 4, 2023

  1. extend __all__ members to template rendering

    Fixes sphinx-doc#10809
    
    * the option autosummary_ignore_module_all when set to False adds members to module's members entry that will be used for autodoc, but otherwise it ignores it. As such, if a class is available in the __all__, it won't be generated.
    * This commit aims at extending the __all__ handling not only to members, but also to corresponding attribute types (function, classes, exceptions, modules)
    * In short, the imported_members option is set to True if the object has __all__ member and autosummary is set to have autosummary_ignore_module_all set to False
    ClementPinard committed Apr 4, 2023
    Copy the full SHA
    7508de1 View commit details
    Browse the repository at this point in the history
  2. Copy the full SHA
    b82b594 View commit details
    Browse the repository at this point in the history
  3. Copy the full SHA
    9d5e86a View commit details
    Browse the repository at this point in the history

Commits on Apr 5, 2023

  1. Copy the full SHA
    a35fdfd View commit details
    Browse the repository at this point in the history
  2. Improve autosummary recursive module

    * When ignore_module_all is False, search for imported modules (possibly renamed) and in discovered modules, public modules are then the one mentioned in __all__
    * In a more general usecase, skip all modules that are overwritten in the package namespace
    ClementPinard committed Apr 5, 2023
    Copy the full SHA
    dd618b9 View commit details
    Browse the repository at this point in the history
  3. Fix linting

    ClementPinard committed Apr 5, 2023
    Copy the full SHA
    e9fad74 View commit details
    Browse the repository at this point in the history
  4. Copy the full SHA
    f2e2d32 View commit details
    Browse the repository at this point in the history