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

sphinx now preserves lots of useful document metadata

Browse Source
This commit is contained in:
Dan MacKinlay 2009-12-22 16:49:40 +11:00
parent 55059117cb
commit d532fc2d9f
2 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
sphinx/environment.py
View File

@ -757,6 +757,7 @@ class BuildEnvironment:
def process_metadata(self, docname, doctree):
"""
Process the docinfo part of the doctree as metadata.
Keep processing minimal - just return what docutils says.
"""
self.metadata[docname] = md = {}
try:
@ -768,10 +769,12 @@ class BuildEnvironment:
# nothing to see here
return
for node in docinfo:
if node.__class__ is nodes.author:
# handled specially by docutils
md['author'] = node.astext()
elif node.__class__ is nodes.field:
# nodes are multiply inherited...
if isinstance(node, nodes.authors):
md['authors'] = [author.astext() for author in node]
elif isinstance(node, nodes.TextElement): #e.g. author
md[node.__class__.__name__] = node.astext()
else:
name, body = node
md[name.astext()] = body.astext()
del doctree[0]

22
tests/test_metadata.py
View File

@ -39,13 +39,29 @@ def teardown_module():
app.cleanup()
def test_docinfo():
"""
inspect the 'docinfo' metadata stored in the first node of the document.
Note this doesn't give us access to data stored in subsequence blocks
that might be considered document metadata, such as 'abstract' or
'dedication' blocks, or the 'meta' role. Doing otherwise is probably more
messing with the internals of sphinx than this rare use case merits.
"""
exampledocinfo = env.metadata['metadata']
expected_metadata = {
'author': u'David Goodger',
u'field name': u'This is a generic bibliographic field.',
u'field name 2': u'Generic bibliographic fields may contain multiple body elements.\n\nLike this.'}
'authors': [u'Me', u'Myself', u'I'],
'address': u'123 Example Street\nExample, EX Canada\nA1B 2C3',
'field name': u'This is a generic bibliographic field.',
'field name 2': u'Generic bibliographic fields may contain multiple body elements.\n\nLike this.',
'status': u'This is a "work in progress"',
'version': u'1',
'copyright': u"This document has been placed in the public domain. You\nmay do with it as you wish. You may copy, modify,\nredistribute, reattribute, sell, buy, rent, lease,\ndestroy, or improve it, quote it at length, excerpt,\nincorporate, collate, fold, staple, or mutilate it, or do\nanything else to it that your or anyone else's heart\ndesires.",
'contact': u'goodger@python.org',
'date': u'2006-05-21',
'organization': u'humankind',
'revision': u'4564'}
# I like this way of comparing dicts - easier to see the error.
for key in exampledocinfo:
yield assert_equals, exampledocinfo[key], expected_metadata[key]
yield assert_equals, exampledocinfo.get(key), expected_metadata.get(key)
#but then we still have to check for missing keys
yield assert_equals, set(expected_metadata.keys()), set(exampledocinfo.keys())