[Checkins] SVN: z3c.recipe.sphinxdoc/trunk/ commit patch from markus korn that allows inclusion of sphinx extensions.
Paul Carduner
paulcarduner at gmail.com
Fri May 1 12:49:42 EDT 2009
Log message for revision 99652:
commit patch from markus korn that allows inclusion of sphinx extensions.
Changed:
U z3c.recipe.sphinxdoc/trunk/CHANGES.txt
U z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/__init__.py
U z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/index.txt
-=-
Modified: z3c.recipe.sphinxdoc/trunk/CHANGES.txt
===================================================================
--- z3c.recipe.sphinxdoc/trunk/CHANGES.txt 2009-05-01 14:31:29 UTC (rev 99651)
+++ z3c.recipe.sphinxdoc/trunk/CHANGES.txt 2009-05-01 16:49:41 UTC (rev 99652)
@@ -10,8 +10,11 @@
- Feature: Changed building behavior so that the documentation for each
package is built in it sown sub-directory.
+
+- Feature: Added new option `extensions` which takes a whitespace
+ separated list of sphinx extension modules. This extensions can be
+ used to build the documentation.
-
0.0.7 (2009-02-15)
------------------
Modified: z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/__init__.py
===================================================================
--- z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/__init__.py 2009-05-01 14:31:29 UTC (rev 99651)
+++ z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/__init__.py 2009-05-01 16:49:41 UTC (rev 99652)
@@ -36,6 +36,7 @@
html_style = 'default.css'
html_static_path = ['%(staticDir)s']
html_last_updated_fmt = '%%b %%d, %%Y'
+extensions = %(extensions)r
"""
class ZopeOrgSetup(object):
@@ -122,7 +123,8 @@
release=metadata.get('Version', doc.version),
staticDir=staticDir,
templatesDir=templatesDir,
- indexDoc=self.options.get('index-doc','index')
+ indexDoc=self.options.get('index-doc','index'),
+ extensions=self.options.get('extensions','').split()
))
confPy.close()
installed.append(confPyPath)
Modified: z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/index.txt
===================================================================
--- z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/index.txt 2009-05-01 14:31:29 UTC (rev 99651)
+++ z3c.recipe.sphinxdoc/trunk/src/z3c/recipe/sphinxdoc/index.txt 2009-05-01 16:49:41 UTC (rev 99652)
@@ -105,4 +105,16 @@
layout.html = /path/to/layout.html
Note that you can either specify a path on the local file system or a
-url to an external css file.
\ No newline at end of file
+url to an external css file.
+
+Use sphinx extension modules
+............................
+
+Sphinx provides a set of extensions, for example `sphinx.ext.autodoc`
+or `sphinx.ext.doctest`. To use such an extension change your
+configuration like::
+
+ [docs]
+ recipe = z3c.recipe.sphinxdoc
+ eggs = z3c.form [docs]
+ extensions = sphinx.ext.autodoc sphinx.ext.doctest
More information about the Checkins
mailing list