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

Add PythonDomain.note_module() to register a python module to the domain

Browse Source
This commit is contained in:
Takeshi KOMIYA
2019-03-31 20:22:38 +09:00
parent 259be8716a
commit 0e837370f5
2 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES
View File

@@ -50,6 +50,7 @@ Features added
* Add a helper class ``sphinx.transforms.post_transforms.SphinxPostTransform``
* Add helper methods
- ``PythonDomain.note_module()``
- ``PythonDomain.note_object()``
- ``SphinxDirective.set_source_info()``

19
sphinx/domains/python.py
View File

@@ -585,12 +585,11 @@ class PyModule(SphinxDirective):
self.env.ref_context['py:module'] = modname
ret = [] # type: List[nodes.Node]
if not noindex:
self.env.domaindata['py']['modules'][modname] = (self.env.docname,
self.options.get('synopsis', ''),
self.options.get('platform', ''),
'deprecated' in self.options)
# make a duplicate entry in 'objects' to facilitate searching for
# the module in PythonDomain.find_obj()
# note module to the domain
domain.note_module(modname,
self.options.get('synopsis', ''),
self.options.get('platform', ''),
'deprecated' in self.options)
domain.note_object(modname, 'module')
targetnode = nodes.target('', '', ids=['module-' + modname],
@@ -798,6 +797,14 @@ class PythonDomain(Domain):
# type: () -> Dict[str, Tuple[str, str, str, bool]]
return self.data.setdefault('modules', {}) # modname -> docname, synopsis, platform, deprecated # NOQA
def note_module(self, name, synopsis, platform, deprecated):
# type: (str, str, str, bool) -> None
"""Note a python module for cross reference.
.. versionadded:: 2.1
"""
self.modules[name] = (self.env.docname, synopsis, platform, deprecated)
def clear_doc(self, docname):
# type: (str) -> None
for fullname, (fn, _l) in list(self.objects.items()):