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 API to add components to a domain.

Browse Source
This commit is contained in:
Georg Brandl 2009-07-28 17:45:02 +00:00
parent 279dd4fa41
commit 72516863b6
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
sphinx/application.py
View File

@ -334,17 +334,21 @@ class Sphinx(object):
if depart: if depart:
setattr(translator, 'depart_'+node.__name__, depart) setattr(translator, 'depart_'+node.__name__, depart)
def add_directive(self, name, obj, content=None, arguments=None, **options): def _directive_helper(self, obj, content=None, arguments=None, **options):
if isinstance(obj, clstypes) and issubclass(obj, Directive): if isinstance(obj, clstypes) and issubclass(obj, Directive):
if content or arguments or options: if content or arguments or options:
raise ExtensionError('when adding directive classes, no ' raise ExtensionError('when adding directive classes, no '
'additional arguments may be given') 'additional arguments may be given')
directives.register_directive(name, directive_dwim(obj)) return directive_dwim(obj)
else: else:
obj.content = content obj.content = content
obj.arguments = arguments obj.arguments = arguments
obj.options = options obj.options = options
directives.register_directive(name, obj) return obj
def add_directive(self, name, obj, content=None, arguments=None, **options):
directives.register_directive(
name, self._directive_helper(obj, content, arguments, **options))
def add_role(self, name, role): def add_role(self, name, role):
roles.register_local_role(name, role) roles.register_local_role(name, role)
@ -356,10 +360,23 @@ class Sphinx(object):
roles.register_local_role(name, role) roles.register_local_role(name, role)
def add_domain(self, domain): def add_domain(self, domain):
# XXX needs to be documented
if domain.name in all_domains: if domain.name in all_domains:
raise ExtensionError('domain %s already registered' % domain.name) raise ExtensionError('domain %s already registered' % domain.name)
all_domains[domain.name] = domain all_domains[domain.name] = domain
def add_directive_to_domain(self, domain, name, obj):
# XXX needs to be documented
if domain not in all_domains:
raise ExtensionError('domain %s not yet registered' % domain)
all_domains[domain].directives[name] = self._directive_helper(obj)
def add_role_to_domain(self, domain, name, role):
# XXX needs to be documented
if domain not in all_domains:
raise ExtensionError('domain %s not yet registered' % domain)
all_domains[domain].roles[name] = role
def add_description_unit(self, directivename, rolename, indextemplate='', def add_description_unit(self, directivename, rolename, indextemplate='',
parse_node=None, ref_nodeclass=None): parse_node=None, ref_nodeclass=None):
additional_xref_types[directivename] = (rolename, indextemplate, additional_xref_types[directivename] = (rolename, indextemplate,

1
sphinx/environment.py
View File

@ -319,6 +319,7 @@ class BuildEnvironment:
# These are set while parsing a file # These are set while parsing a file
self.docname = None # current document name self.docname = None # current document name
# XXX remove currmodule and currclass from here
self.currmodule = None # current module name self.currmodule = None # current module name
self.currclass = None # current class name self.currclass = None # current class name
self.currdesc = None # current descref name self.currdesc = None # current descref name