You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
I would expect autodoc_mock_imports (and autosummary_mock_imports, the behavior seems to be the same) to exclude an entire module from a project that has been automatically iterated over using the :recursive: option available to sphinx.ext.autosummary since Sphinx 3.1.
It excludes the content of that module, but not the module itself, which ends up as an 'empty' entry in the summary table.
Edit source/conf.py and add the line autodoc_mock_imports = ['mytoolbox.mymodule2'].
Follow the instructions in the Github Readme to rebuild and view the docs locally.
Expected behavior mytoolbox.mymodule2 is excluded from the summary table completely.
Actual behavior mytoolbox.mymodule2 is still listed in the summary table. Click on it, though, and the module is empty - the class it contains is not documented.
The text was updated successfully, but these errors were encountered:
Describe the bug
I would expect
autodoc_mock_imports
(andautosummary_mock_imports
, the behavior seems to be the same) to exclude an entire module from a project that has been automatically iterated over using the:recursive:
option available tosphinx.ext.autosummary
since Sphinx 3.1.It excludes the content of that module, but not the module itself, which ends up as an 'empty' entry in the summary table.
To Reproduce
Steps to reproduce:
mytoolbox.mymodule2
is fully documented.source/conf.py
and add the lineautodoc_mock_imports = ['mytoolbox.mymodule2']
.Expected behavior
mytoolbox.mymodule2
is excluded from the summary table completely.Actual behavior
mytoolbox.mymodule2
is still listed in the summary table. Click on it, though, and the module is empty - the class it contains is not documented.The text was updated successfully, but these errors were encountered: