sphinx/doc/usage
Stephen Finucane 6b37a6b2a2
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 07:36:36 +01:00
..
advanced Rewrite `usage/configuration.rst` (#12537) 2024-07-10 21:43:14 +01:00
builders [lint] update Makefile and lint doc (#12117) 2024-03-17 14:45:56 +01:00
domains Add a new `confval` directive to document settings and configuration values (#12536) 2024-07-10 20:44:16 +01:00
extensions Allow explicitly specifying modules in the coverage builder (#11592) 2024-07-11 07:36:36 +01:00
restructuredtext Rewrite `usage/configuration.rst` (#12537) 2024-07-10 21:43:14 +01:00
configuration.rst Allow configuring the separator used in numbering equations (#12523) 2024-07-10 22:23:38 +01:00
index.rst Move cross-referencing to a new page 2023-10-03 19:32:37 +01:00
installation.rst DOC: Rewrite installation instructions (#12458) 2024-06-25 12:17:55 +02:00
markdown.rst Recommend MyST-Parser for Markdown usage 2021-04-15 20:31:13 +02:00
quickstart.rst [docs] add icons to admonition titles (#12486) 2024-06-27 23:06:52 +02:00
referencing.rst Add a new `confval` directive to document settings and configuration values (#12536) 2024-07-10 20:44:16 +01:00
theming.rst [docs] Improve landing page (#12453) 2024-06-21 20:12:57 +02:00