readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
432 stars 128 forks source link

does autoapi honnor private members ? #400

Closed 12rambau closed 1 year ago

12rambau commented 1 year ago

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 commented 1 year ago

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