mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Added referencing and indexing for rst domain.
This commit is contained in:
parent
94cec11884
commit
84a65f257b
@ -20,10 +20,40 @@ from sphinx.roles import XRefRole
|
||||
from sphinx.util.nodes import make_refnode
|
||||
from sphinx.util.docfields import Field, GroupedField, TypedField
|
||||
|
||||
class ReSTDirective(ObjectDescription):
|
||||
class ReSTMarkup(ObjectDescription):
|
||||
def handle_signature(self, sig, signode):
|
||||
signode.clear()
|
||||
signode += addnodes.desc_name(sig, sig)
|
||||
return sig
|
||||
|
||||
def add_target_and_index(self, name, sig, signode):
|
||||
if name not in self.state.document.ids:
|
||||
signode['names'].append(name)
|
||||
signode['ids'].append(name)
|
||||
signode['first'] = (not self.names)
|
||||
self.state.document.note_explicit_target(signode)
|
||||
|
||||
objects = self.env.domaindata['rst']['objects']
|
||||
#XXX add warning for duplicate definitions
|
||||
objects[name] = self.env.docname, self.objtype
|
||||
print self.objtype, name
|
||||
indextext = self.get_index_text(self.objtype, name)
|
||||
if indextext:
|
||||
self.indexnode['entries'].append(('single', indextext,
|
||||
name, name))
|
||||
|
||||
def get_index_text(self, objectname, name):
|
||||
if self.objtype == 'directive':
|
||||
return _('%s (directive)') % name
|
||||
elif self.objtype == 'role':
|
||||
return _('%s (role)') % name
|
||||
return ''
|
||||
|
||||
|
||||
class ReSTDirective(ReSTMarkup):
|
||||
pass
|
||||
|
||||
class ReSTRole(ObjectDescription):
|
||||
class ReSTRole(ReSTMarkup):
|
||||
pass
|
||||
|
||||
class ReSTXRefRole(XRefRole):
|
||||
@ -46,9 +76,18 @@ class ReSTDomain(Domain):
|
||||
'dir': ReSTXRefRole(),
|
||||
'role': ReSTXRefRole(),
|
||||
}
|
||||
|
||||
|
||||
|
||||
initial_data = {
|
||||
'objects': {}, # fullname -> docname, objtype
|
||||
}
|
||||
|
||||
def resolve_xref(self, env, fromdocname, builder, typ, target, node,
|
||||
contnode):
|
||||
objects = self.data['objects']
|
||||
|
||||
if not target in objects:
|
||||
return None
|
||||
return make_refnode(builder, fromdocname, objects[target][0], target,
|
||||
contnode, target)
|
||||
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user