summaryrefslogtreecommitdiff
path: root/doc/config.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2014-01-12 20:46:50 +0100
committerGeorg Brandl <georg@python.org>2014-01-12 20:46:50 +0100
commit0ce3e1b81e8105ccf99e497b6c82c1ef8d9201ba (patch)
tree0ce8237ff67cff3ef0871472677f3f3ff88c7633 /doc/config.rst
parentd68a60584728f81beffc95debdfe54b37c03be05 (diff)
parente49c27d634c942f36bcbc72e659bbb5bcd39066f (diff)
downloadsphinx-0ce3e1b81e8105ccf99e497b6c82c1ef8d9201ba.tar.gz
merge with stable
Diffstat (limited to 'doc/config.rst')
-rw-r--r--doc/config.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/config.rst b/doc/config.rst
index 714df6eb..78bca929 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -236,7 +236,8 @@ General configuration
A list of ``(type, target)`` tuples (by default empty) that should be ignored
when generating warnings in "nitpicky mode". Note that ``type`` should
- include the domain name. An example entry would be ``('py:func', 'int')``.
+ include the domain name if present. Example entries would be ``('py:func',
+ 'int')`` or ``('envvar', 'LD_LIBRARY_PATH')``.
.. versionadded:: 1.1