diff options
| author | Georg Brandl <georg@python.org> | 2011-05-15 13:00:11 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2011-05-15 13:00:11 +0200 |
| commit | e44c7e00563271f162ecd680ae151c013ac6c462 (patch) | |
| tree | 3bb30963722e617ec9ce4e122d16ef15e6597389 /sphinx/domains/python.py | |
| parent | 3ea4ee1aec7140401bda55786a7e27fdc699403f (diff) | |
| download | sphinx-e44c7e00563271f162ecd680ae151c013ac6c462.tar.gz | |
Closes #669: Respect the ``noindex`` flag option in py:module directives.
Diffstat (limited to 'sphinx/domains/python.py')
| -rw-r--r-- | sphinx/domains/python.py | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/sphinx/domains/python.py b/sphinx/domains/python.py index d2242cdd..0220afd0 100644 --- a/sphinx/domains/python.py +++ b/sphinx/domains/python.py @@ -381,15 +381,18 @@ class PyModule(Directive): modname = self.arguments[0].strip() noindex = 'noindex' in self.options env.temp_data['py:module'] = modname - env.domaindata['py']['modules'][modname] = \ - (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() - env.domaindata['py']['objects'][modname] = (env.docname, 'module') - targetnode = nodes.target('', '', ids=['module-' + modname], ismod=True) - self.state.document.note_explicit_target(targetnode) - ret = [targetnode] + ret = [] + if not noindex: + env.domaindata['py']['modules'][modname] = \ + (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() + env.domaindata['py']['objects'][modname] = (env.docname, 'module') + targetnode = nodes.target('', '', ids=['module-' + modname], + ismod=True) + self.state.document.note_explicit_target(targetnode) + ret.append(targetnode) # XXX this behavior of the module directive is a mess... if 'platform' in self.options: platform = self.options['platform'] |