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

does autoapi honnor private members ? #400

Closed
12rambau opened this issue Aug 22, 2023 · 1 comment
Closed

does autoapi honnor private members ? #400

12rambau opened this issue Aug 22, 2023 · 1 comment

Comments

@12rambau
Copy link

I'm writting the documentation of the ipyvuetify lib.

The internal strucure is hidden behind the public "ipyvuetify" API so I would like to hide some module, function and packages from documentation reader.

In this first build, a _version.py file is imported and surprisingly it is listed in the submodules list.
Same goes for 2 private method in the init file: _jupyter_labextension_paths.

Is it expected or is it a bug ?

@12rambau
Copy link
Author

I should have been more careful when reading the documentation. private memeber are included by default. I changed this in my conf.py and it now works as expected:

autoapi_options = [ 'members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'special-members', 'imported-members']

https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html#confval-autoapi_options

sorry for the noise

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

No branches or pull requests

1 participant