IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
dec45eaf28
sphinx/tests/roots/test-ext-coverage/index.rst

7 lines
108 B
ReStructuredText
Raw Normal View History

Allow explicitly specifying modules in the coverage builder (#11592) Currently there is no mechanism to identify totally undocumented modules in the coverage builder, unlike with partially documented modules. Resolve this by introducing a new ``coverage_modules`` config option. This is a list of modules that should be documented somewhere within the documentation tree. Any modules that are specified in the configuration value but are not documented anywhere will result in a warning. Likewise, any modules that are not in the config option but are documented somewhere will result in a warning. Signed-off-by: Stephen Finucane <stephen@that.guru>
2024-07-11 01:36:36 -05:00
.. automodule:: grog.coverage_ignored
Support coverage_ignore_pyobjects in the coverage builder
2019-05-14 07:48:52 -05:00
:members:
Allow explicitly specifying modules in the coverage builder (#11592) Currently there is no mechanism to identify totally undocumented modules in the coverage builder, unlike with partially documented modules. Resolve this by introducing a new ``coverage_modules`` config option. This is a list of modules that should be documented somewhere within the documentation tree. Any modules that are specified in the configuration value but are not documented anywhere will result in a warning. Likewise, any modules that are not in the config option but are documented somewhere will result in a warning. Signed-off-by: Stephen Finucane <stephen@that.guru>
2024-07-11 01:36:36 -05:00
.. automodule:: grog.coverage_not_ignored
Support coverage_ignore_pyobjects in the coverage builder
2019-05-14 07:48:52 -05:00
:members:
Reference in New Issue Copy Permalink