1. Chris McDonough
  2. sphinx


dan mackinlay  committed 3542301

sphinx now preserves lots of useful document metadata

  • Participants
  • Parent commits a70af00
  • Branches default

Comments (0)

Files changed (2)

File sphinx/environment.py

View file
     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 = {}
             # nothing to see here
         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]

File tests/test_metadata.py

View file
 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())