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

Include special methods with automodapi? #27

Open
jonathansick opened this issue Apr 22, 2018 · 1 comment
Open

Include special methods with automodapi? #27

jonathansick opened this issue Apr 22, 2018 · 1 comment

Comments

@jonathansick
Copy link
Member

jonathansick commented Apr 22, 2018

We want to include special methods (i.e., dunder methods) in the API references that we make through [automodapi](https://github.com/astropy/sphinx-automodapi/]. Sphinx autodoc supports with with a special-members option:

.. autoclass:: my.Class
   :members:
   :special-members:

It looks like the place to implement this is https://github.com/astropy/sphinx-automodapi/blob/master/sphinx_automodapi/automodapi.py#L308-L312 I think we can PR to sphinx-automodapi to add a private-members option to automodapi that's passed through to the autoclass directives.

@jonathansick
Copy link
Member Author

Possibly this could be implemented simply through the autodoc_default_flags configuration.

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

1 participant