[Checkins] SVN: buildout-website/trunk/source/conf.py Cleanup

Baiju M baiju.m.mail at gmail.com
Thu Apr 23 12:28:57 EDT 2009


Log message for revision 99428:
  Cleanup
  

Changed:
  U   buildout-website/trunk/source/conf.py

-=-
Modified: buildout-website/trunk/source/conf.py
===================================================================
--- buildout-website/trunk/source/conf.py	2009-04-23 16:08:18 UTC (rev 99427)
+++ buildout-website/trunk/source/conf.py	2009-04-23 16:28:56 UTC (rev 99428)
@@ -5,23 +5,24 @@
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
-# The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed automatically).
+# Note that not all possible configuration values are present in this
+# autogenerated file.
 #
-# All configuration values have a default value; values that are commented out
-# serve to show the default value.
+# All configuration values have a default; values that are commented out
+# serve to show the default.
 
-import sys
+import sys, os
 
-# If your extensions are in another directory, add it here.
-sys.path.append('extensions')
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
 
-# General configuration
-# ---------------------
+# -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-#JEFF extensions = ['embeddedvideo', 'recipes']
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -29,6 +30,9 @@
 # The suffix of source filenames.
 source_suffix = '.rst'
 
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
 # The master toctree document.
 master_doc = 'index'
 
@@ -48,11 +52,18 @@
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+#today_fmt = '%B %d, %Y'
 
 # List of documents that shouldn't be included in the build.
 #unused_docs = []
 
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
 
@@ -67,12 +78,16 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
 
-# Options for HTML output
-# -----------------------
 
-#JEFF html_translator_class = 'embeddedvideo.MyHTMLTranslator'
+# -- Options for HTML output ---------------------------------------------------
 
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
 html_theme = 'buildout_theme'
 html_theme_path = ['.']
 
@@ -88,7 +103,7 @@
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+#html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -106,14 +121,14 @@
 # If false, no module index is generated.
 html_use_modindex = False
 
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-html_copy_source = True
+# If false, no index is generated.
+#html_use_index = True
 
 # Output file base name for HTML help builder.
 #htmlhelp_basename = 'Buildoutdoc'
 
-# Add "permalinks" for each heading and description.
-html_add_permalinks = True
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
 
 # An .ico format of file that is 16x16 or 32x32 pixels in size.
 html_favicon = '_static/hammer-foot.ico'
@@ -124,8 +139,7 @@
 
 
 
-# Options for LaTeX output
-# ------------------------
+# -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
 #latex_paper_size = 'letter'
@@ -134,9 +148,20 @@
 #latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, document class [howto/manual]).
-#latex_documents = []
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'buildout.tex', u'Buildout',
+   u'Jim Fulton', 'manual'),
+]
 
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
 # Additional stuff for the LaTeX preamble.
 #latex_preamble = ''
 



More information about the Checkins mailing list