Make Sphinx check for undefined references & .gitignore _build. (open…

…-telemetry#32)
owais · Jun 27, 2019 · d7d9907 · d7d9907
1 parent ad7bda6
commit d7d9907
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -47,3 +47,6 @@ htmlcov
 
 # VSCode
 .vscode
+
+# Sphinx
+_build/
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,6 +40,13 @@
     'sphinx.ext.intersphinx',
 ]
 
+intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}
+
+# http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
+# Sphinx will warn about all references where the target cannot be found.
+nitpicky = True
+nitpick_ignore = []
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']