IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

#537: Added :confval:nitpick_ignore.

Browse Source
This commit is contained in:
Georg Brandl 2011-01-08 18:36:52 +01:00
parent 1d6d183193
commit f5ecd62d05
4 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -83,6 +83,8 @@ Release 1.1 (in development)
* #590: Added ``caption`` option to graphviz directives. * #590: Added ``caption`` option to graphviz directives.
* #537: Added :confval:`nitpick_ignore`.
* C++ domain now supports array definitions. * C++ domain now supports array definitions.

8
doc/config.rst
View File

@ -232,6 +232,14 @@ General configuration
.. versionadded:: 1.0 .. versionadded:: 1.0
.. confval:: nitpick_ignore
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')``.
.. versionadded:: 1.1
Project information Project information
------------------- -------------------

1
sphinx/config.py
View File

@ -71,6 +71,7 @@ class Config(object):
primary_domain = ('py', 'env'), primary_domain = ('py', 'env'),
needs_sphinx = (None, None), needs_sphinx = (None, None),
nitpicky = (False, 'env'), nitpicky = (False, 'env'),
nitpick_ignore = ([], 'env'),
# HTML options # HTML options
html_theme = ('default', 'html'), html_theme = ('default', 'html'),

11
sphinx/environment.py
View File

@ -69,7 +69,7 @@ default_settings = {
# This is increased every time an environment attribute is added # This is increased every time an environment attribute is added
# or changed to properly invalidate pickle files. # or changed to properly invalidate pickle files.
ENV_VERSION = 40 ENV_VERSION = 41
default_substitutions = set([ default_substitutions = set([
@ -340,6 +340,9 @@ class BuildEnvironment:
# this is to invalidate old pickles # this is to invalidate old pickles
self.version = ENV_VERSION self.version = ENV_VERSION
# make this a set for faster testing
self._nitpick_ignore = set(self.config.nitpick_ignore)
# All "docnames" here are /-separated and relative and exclude # All "docnames" here are /-separated and relative and exclude
# the source suffix. # the source suffix.
@ -1465,7 +1468,11 @@ class BuildEnvironment:
def _warn_missing_reference(self, fromdoc, typ, target, node, domain): def _warn_missing_reference(self, fromdoc, typ, target, node, domain):
warn = node.get('refwarn') warn = node.get('refwarn')
if self.config.nitpicky: if self.config.nitpicky:
warn = True # XXX process exceptions here warn = True
if self._nitpick_ignore:
dtype = domain and '%s:%s' % (domain.name, typ) or typ
if (dtype, target) in self._nitpick_ignore:
warn = False
if not warn: if not warn:
return return
refdoc = node.get('refdoc', fromdoc) refdoc = node.get('refdoc', fromdoc)