diff options
| author | Georg Brandl <georg@python.org> | 2014-01-12 20:46:50 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-12 20:46:50 +0100 |
| commit | 0ce3e1b81e8105ccf99e497b6c82c1ef8d9201ba (patch) | |
| tree | 0ce8237ff67cff3ef0871472677f3f3ff88c7633 /doc | |
| parent | d68a60584728f81beffc95debdfe54b37c03be05 (diff) | |
| parent | e49c27d634c942f36bcbc72e659bbb5bcd39066f (diff) | |
| download | sphinx-0ce3e1b81e8105ccf99e497b6c82c1ef8d9201ba.tar.gz | |
merge with stable
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 3 | ||||
| -rw-r--r-- | doc/invocation.rst | 3 |
2 files changed, 4 insertions, 2 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 diff --git a/doc/invocation.rst b/doc/invocation.rst index 4f4d81ac..97b1e1b7 100644 --- a/doc/invocation.rst +++ b/doc/invocation.rst @@ -149,7 +149,8 @@ The :program:`sphinx-build` script has several options: .. option:: -n Run in nit-picky mode. Currently, this generates warnings for all missing - references. + references. See the config value :confval:`nitpick_ignore` for a way to + exclude some references as "known missing". .. option:: -N |