How to use Sphix's sphinx.ext.coverage's coverage_show_missing_items?

user_1207596 0
Viewed 1141

Sorry, I am a newbie trying to add Sphinx to auto-generate documentation for a Django project and also ensure sufficient documentation coverage of the project.

I want to configure Sphinx to tell me which Objects are missing documentation by using the coverage_show_missing_items flag, specified here:
https://www.sphinx-doc.org/ar/master/usage/extensions/coverage.html#confval-coverage_show_missing_items

Unfortunately, I have not been able to figure out where/how to set this configuration. My Google-fu didn't come up with any examples on how to configure these settings.

I'm guessing it should go inside conf.py somewhere, but haven't come across any examples on how to do it.

documentation-generation python-sphinx documentation django python
1 Answers

With almost every Sphinx extension, one may configure options either in conf.py or the command line. For your case, put this somewhere in your conf.py where you see extensions:

extensions = [
    #...
    sphinx.ext.coverage,
]

#...
# Configuration of sphinx.ext.coverage
coverage_show_missing_items = True
user_22149330
Related