[Checkins] SVN: groktoolkit/branches/jw-documentation-rearangement/doc/c sync the conf.py to that of the much newer conf.py in the grok package

[Jan-Wijbrand Kolman]

Log message for revision 119564:
  sync the conf.py to that of the much newer conf.py in the grok package

Changed:
  U   groktoolkit/branches/jw-documentation-rearangement/doc/changes.rst
  U   groktoolkit/branches/jw-documentation-rearangement/doc/conf.py

-=-
Modified: groktoolkit/branches/jw-documentation-rearangement/doc/changes.rst
===================================================================
--- groktoolkit/branches/jw-documentation-rearangement/doc/changes.rst	2011-01-13 12:19:25 UTC (rev 119563)
+++ groktoolkit/branches/jw-documentation-rearangement/doc/changes.rst	2011-01-13 12:54:14 UTC (rev 119564)
@@ -1 +1,4 @@
-.. include:: ../CHANGES.txt
+Changes
+=======
+
+

Modified: groktoolkit/branches/jw-documentation-rearangement/doc/conf.py
===================================================================
--- groktoolkit/branches/jw-documentation-rearangement/doc/conf.py	2011-01-13 12:19:25 UTC (rev 119563)
+++ groktoolkit/branches/jw-documentation-rearangement/doc/conf.py	2011-01-13 12:54:14 UTC (rev 119564)
@@ -19,19 +19,37 @@
 # If your extensions are in another directory, add it here.
 #sys.path.append('some/directory')
 
-# General configuration
-# ---------------------
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
 
+import sys, os
+
+# 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.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.doctest',
-              'sphinx.ext.intersphinx',
-              # 'sphinx.ext.viewcode', # This is currently broken?
-              ]
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+    ]
 
 # Order autodoc generated docs in source code order.
-autodoc_member_order = 'bysource'
+autodoc_member_order = 'alphabetical'
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['.']
@@ -60,11 +78,15 @@
 # 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 = ['build']
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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
 
@@ -72,48 +94,74 @@
 # unit titles (such as .. function::).
 #add_module_names = True
 
+# -- Options for HTML output ---------------------------------------------------
 
-# Options for HTML output
-# -----------------------
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Grokdoc'
 
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# The style sheet to use for HTML and HTML Help pages. A file of that name
+# must exist either in Sphinx' static/ path, or in one of the custom paths
+# given in html_static_path.
+html_style = 'grok.css'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
 # 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.
-html_use_smartypants = True
+#html_use_smartypants = True
 
-# Custom sidebar templates, maps page names to filenames relative to this file.
+# Custom sidebar templates, maps document names to template names.
 #html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
-# filenames relative to this file.
+# template names.
 html_additional_pages = {'index':'docindex.template'}
 
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
 # If true, the reST sources are included in the HTML build as _sources/<name>.
 #html_copy_source = True
 
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Grokdoc'
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
 
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-html_style = 'grok.css'
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = [path.join(path.abspath(curdir), '_static')]
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
 
+# Output file base name for HTML help builder.
+# htmlhelp_basename = 'grokdoc'
 
-# Options for LaTeX output
-# ------------------------
 
+# -- Options for LaTeX output --------------------------------------------------
+
 # The paper size ('letter' or 'a4').
 #latex_paper_size = 'letter'
 
@@ -142,3 +190,20 @@
 
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'grok', u'grok Documentation',
+     [u'The Grok developers and community'], 1)
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}