Commits

Georg Brandl committed a26c9e1

Fix some nits after pulling from http://bitbucket.org/howthebodyworks/sphinx/ and add changelog and authors entries.

  • Participants
  • Parent commits 3542301

Comments (0)

Files changed (4)

 * Martin Hans -- autodoc improvements
 * Dave Kuhlman -- original LaTeX writer
 * Thomas Lamb -- linkcheck builder
+* Dan MacKinlay -- metadata fixes
 * Will Maier -- directory HTML builder
 * Christopher Perkins -- autosummary integration
 * Benjamin Peterson -- unittests
 Release 1.0 (in development)
 ============================
 
+* All docinfo metadata is now put into the document metadata, not just
+  the author.
+
 * Added new HTML theme ``agogo``, created by Andi Albrecht.
 
 * Added new minimal theme called scrolls, created by Armin Ronacher.

File sphinx/environment.py

 import re
 import os
 import time
-import heapq
 import types
 import codecs
 import imghdr
 import string
-import difflib
 import cPickle as pickle
 from os import path
 from glob import glob
     def process_metadata(self, docname, doctree):
         """
         Process the docinfo part of the doctree as metadata.
-        Keep processing minimal - just return what docutils says.
+        Keep processing minimal -- just return what docutils says.
         """
         self.metadata[docname] = md = {}
         try:
             # 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
+            elif isinstance(node, nodes.TextElement): # e.g. author
                 md[node.__class__.__name__] = node.astext()
             else:
                 name, body = node

File tests/test_metadata.py

     test_metadata
     ~~~~~~~~~~~~~
 
-    Test our ahndling of metadata in files with bibliographic metadata
+    Test our handling of metadata in files with bibliographic metadata.
 
     :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
     :license: BSD, see LICENSE for details.
 """
 
-
-
-# adapted from an example of bibliographic metadata at http://docutils.sourceforge.net/docs/user/rst/demo.txt
+# adapted from an example of bibliographic metadata at
+# http://docutils.sourceforge.net/docs/user/rst/demo.txt
 
 from util import *
 
 from nose.tools import assert_equals
 
 from sphinx.environment import BuildEnvironment
-from sphinx.builders.html import StandaloneHTMLBuilder
-from sphinx.builders.latex import LaTeXBuilder
 
 app = env = None
 warnings = []
     app = TestApp(srcdir='(temp)')
     env = BuildEnvironment(app.srcdir, app.doctreedir, app.config)
     # Huh. Why do I need to do this?
-    env.set_warnfunc(lambda *args: warnings.append(args)) 
+    env.set_warnfunc(lambda *args: warnings.append(args))
     msg, num, it = env.update(app.config, app.srcdir, app.doctreedir, app)
     for docname in it:
         pass
 
 def test_docinfo():
     """
-    inspect the 'docinfo' metadata stored in the first node of the document.
+    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',
-      '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'}
+    expecteddocinfo = {
+        'author': u'David Goodger',
+        '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 '
+                         u'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. '
+                      u'You\nmay do with it as you wish. You may copy, modify,'
+                      u'\nredistribute, reattribute, sell, buy, rent, lease,\n'
+                      u'destroy, or improve it, quote it at length, excerpt,\n'
+                      u'incorporate, collate, fold, staple, or mutilate it, or '
+                      u'do\nanything else to it that your or anyone else\'s '
+                      u'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.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())
+        yield assert_equals, exampledocinfo.get(key), expecteddocinfo.get(key)
+    # but then we still have to check for missing keys
+    yield assert_equals, set(expecteddocinfo.keys()), set(exampledocinfo.keys())