mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
6b37a6b2a2
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>
16 lines
283 B
Python
16 lines
283 B
Python
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
|
|
|
|
coverage_modules = [
|
|
'grog',
|
|
]
|
|
coverage_ignore_pyobjects = [
|
|
r'^grog\.coverage_ignored(\..*)?$',
|
|
r'\.Ignored$',
|
|
r'\.Documented\.ignored\d$',
|
|
]
|