Skip to content

Commit d7d9907

Browse files
authored
Make Sphinx check for undefined references & .gitignore _build. (open-telemetry#32)
1 parent ad7bda6 commit d7d9907

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,6 @@ htmlcov
4747

4848
# VSCode
4949
.vscode
50+
51+
# Sphinx
52+
_build/

docs/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@
4040
'sphinx.ext.intersphinx',
4141
]
4242

43+
intersphinx_mapping = {'python': ('https://docs.python.org/3/', None)}
44+
45+
# http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
46+
# Sphinx will warn about all references where the target cannot be found.
47+
nitpicky = True
48+
nitpick_ignore = []
49+
4350
# Add any paths that contain templates here, relative to this directory.
4451
templates_path = ['_templates']
4552

0 commit comments

Comments
 (0)