Merge remote-tracking branch 'origin/master' into doc-update

Author: mlech-reef

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 * Fix for the Windows bundled version
+* Fix docs autogen
 
 ## [2.1.0] - 2020-11-03
 

doc/source/conf.py

@@ -43,7 +43,11 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.coverage',
     'sphinxarg.ext'
 ]
 

noxfile.py

@@ -192,9 +192,25 @@ def doc(session):
 
     if not session.interactive:
         session.run('sphinx-build', *sphinx_args)
-        # TODO: implement doc_cover that works with sphinx-argparse
+        session.notify('doc_cover')
     else:
         sphinx_args[-2:-2] = [
-            '--open-browser', '--watch', '../b2', '--ignore', '*.pyc', '--ignore', '*~'
+            '-E', '--open-browser', '--watch', '../b2', '--ignore', '*.pyc', '--ignore', '*~'
         ]
         session.run('sphinx-autobuild', *sphinx_args)
+
+
+@nox.session
+def doc_cover(session):
+    """Perform coverage analysis for the documentation."""
+    install_myself(session, extras=['doc'])
+    session.cd('doc')
+    sphinx_args = ['-b', 'coverage', '-T', '-W', 'source', 'build/coverage']
+    report_file = 'build/coverage/python.txt'
+    session.run('sphinx-build', *sphinx_args)
+    session.run('cat', report_file, external=True)
+
+    with open('build/coverage/python.txt') as fd:
+        # If there is no undocumented files, the report should have only 2 lines (header)
+        if sum(1 for _ in fd) != 2:
+            session.error('sphinx coverage has failed')