aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
diff options
context:
space:
mode:
authorJannis Leidel <jannis@leidel.info>2009-10-08 15:10:08 +0200
committerJannis Leidel <jannis@leidel.info>2009-10-08 15:10:08 +0200
commit079951a1532a2c9e3295253c65e06091758f9150 (patch)
treed1ed20f7e6cb8aadad73f22448e973dd593e37b5 /docs/conf.py
parent0867ba6e43bc687947b24d77efdbe416fcc38780 (diff)
downloadexternal_python_setuptools-079951a1532a2c9e3295253c65e06091758f9150.tar.gz
external_python_setuptools-079951a1532a2c9e3295253c65e06091758f9150.tar.bz2
external_python_setuptools-079951a1532a2c9e3295253c65e06091758f9150.zip
Updated Sphinx config, e.g. to add theme support
--HG-- branch : distribute extra : rebase_source : b23e8bc5fa516fc6d0a2b232127c9d8b43cdb067
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py51
1 files changed, 29 insertions, 22 deletions
diff --git a/docs/conf.py b/docs/conf.py
index d4ff4a15..bad1a578 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,20 +16,19 @@
import sys, os
-# If your extensions are in another directory, add it here. If the directory
-# is relative to the documentation root, use os.path.abspath to make it
-# absolute, like shown here.
+# 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.
extensions = []
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
+templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.txt'
@@ -49,9 +48,9 @@ copyright = u'2009, The fellowship of the packaging'
# built documents.
#
# The short X.Y version.
-version = '0.6.1'
+version = '0.6.4'
# The full version, including alpha/beta/rc tags.
-release = '0.6.1'
+release = '0.6.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -87,21 +86,30 @@ exclude_trees = []
# 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
-# -----------------------
-# 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 = 'default.css'
+# -- 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 = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['_theme']
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-#html_title = None
+html_title = "Distribute documentation"
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+html_short_title = "Distribute"
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@ -115,7 +123,7 @@ html_style = 'default.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']
+#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@@ -141,8 +149,8 @@ html_static_path = ['.static']
# If true, the index is split into individual pages for each letter.
#html_split_index = False
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
# 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
@@ -156,8 +164,7 @@ html_static_path = ['.static']
htmlhelp_basename = 'Distributedoc'
-# Options for LaTeX output
-# ------------------------
+# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
@@ -166,7 +173,7 @@ htmlhelp_basename = 'Distributedoc'
#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]).
+# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'Distribute.tex', ur'Distribute Documentation',
ur'The fellowship of the packaging', 'manual'),