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

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

Open
cdeil opened this issue Sep 8, 2017 · 1 comment
Open

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

cdeil opened this issue Sep 8, 2017 · 1 comment

Comments

@cdeil
Copy link
Member

cdeil commented Sep 8, 2017

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?

@astrofrog
Copy link
Member

👍 to add a global option - would you have time to do this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants