Skip to content

Expose include-all-objects as global Sphinx option? #35

@cdeil

Description

@cdeil

For Gammapy I would like to adopt the default of include-all-objects globally for the docs.

How about adding a automodapi_include_all_object global Sphinx option?

I think it's pretty common to want everything I list in __all__ (e.g. module-level variables like default values or dictionaries) to show up in the docs, no?

For now, is there a way to achieve this default globally for Gammapy?
Or do I have to add :include-all-objects: to every automodapi directive?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions