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

refactor: Move pairindextypes to sphinx.domains.python

Browse Source
This commit is contained in:
Takeshi KOMIYA 2018-02-24 16:48:12 +09:00
parent 50ffe5b7c2
commit ad7d77d010
4 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/builders/gettext.py
View File

@ -22,7 +22,7 @@ from uuid import uuid4
from six import iteritems, StringIO from six import iteritems, StringIO
from sphinx.builders import Builder from sphinx.builders import Builder
from sphinx.locale import pairindextypes from sphinx.domains.python import pairindextypes
from sphinx.util import split_index_msg, logging, status_iterator from sphinx.util import split_index_msg, logging, status_iterator
from sphinx.util.console import bold # type: ignore from sphinx.util.console import bold # type: ignore
from sphinx.util.i18n import find_catalog from sphinx.util.i18n import find_catalog

21
sphinx/domains/python.py
View File

@ -16,7 +16,8 @@ from docutils import nodes
from docutils.parsers.rst import Directive, directives from docutils.parsers.rst import Directive, directives
from six import iteritems from six import iteritems
from sphinx import addnodes from sphinx import addnodes, locale
from sphinx.deprecation import DeprecatedDict, RemovedInSphinx30Warning
from sphinx.directives import ObjectDescription from sphinx.directives import ObjectDescription
from sphinx.domains import Domain, ObjType, Index from sphinx.domains import Domain, ObjType, Index
from sphinx.locale import _ from sphinx.locale import _
@ -44,6 +45,24 @@ py_sig_re = re.compile(
''', re.VERBOSE) ''', re.VERBOSE)
pairindextypes = {
'module': _('module'),
'keyword': _('keyword'),
'operator': _('operator'),
'object': _('object'),
'exception': _('exception'),
'statement': _('statement'),
'builtin': _('built-in function'),
} # Dict[unicode, unicode]
locale.pairindextypes = DeprecatedDict(
pairindextypes,
'sphinx.locale.pairindextypes is deprecated. '
'Please use sphinx.domains.python.pairindextypes instead.',
RemovedInSphinx30Warning
)
def _pseudo_parse_arglist(signode, arglist): def _pseudo_parse_arglist(signode, arglist):
# type: (addnodes.desc_signature, unicode) -> None # type: (addnodes.desc_signature, unicode) -> None
""""Parse" a list of arguments separated by commas. """"Parse" a list of arguments separated by commas.

12
sphinx/locale/__init__.py
View File

@ -347,13 +347,5 @@ admonitionlabels = {
# Moved to sphinx.directives.other (will be overrided later) # Moved to sphinx.directives.other (will be overrided later)
versionlabels = {} versionlabels = {}
# XXX Python specific # Moved to sphinx.domains.python (will be overrided later)
pairindextypes = { pairindextypes = {}
'module': _('module'),
'keyword': _('keyword'),
'operator': _('operator'),
'object': _('object'),
'exception': _('exception'),
'statement': _('statement'),
'builtin': _('built-in function'),
} # Dict[unicode, _TranslationProxy]

3
sphinx/util/nodes.py
View File

@ -17,7 +17,6 @@ from docutils import nodes
from six import text_type from six import text_type
from sphinx import addnodes from sphinx import addnodes
from sphinx.locale import pairindextypes
from sphinx.util import logging from sphinx.util import logging
if TYPE_CHECKING: if TYPE_CHECKING:
@ -240,6 +239,8 @@ indextypes = [
def process_index_entry(entry, targetid): def process_index_entry(entry, targetid):
# type: (unicode, unicode) -> List[Tuple[unicode, unicode, unicode, unicode, unicode]] # type: (unicode, unicode) -> List[Tuple[unicode, unicode, unicode, unicode, unicode]]
from sphinx.domains.python import pairindextypes
indexentries = [] # type: List[Tuple[unicode, unicode, unicode, unicode, unicode]] indexentries = [] # type: List[Tuple[unicode, unicode, unicode, unicode, unicode]]
entry = entry.strip() entry = entry.strip()
oentry = entry oentry = entry