diff options
Diffstat (limited to 'doc/conf.py')
| -rw-r--r-- | doc/conf.py | 68 |
1 files changed, 33 insertions, 35 deletions
diff --git a/doc/conf.py b/doc/conf.py index eedf48d..a1af384 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,10 +1,13 @@ # -*- coding: utf-8 -*- # -# argparse documentation build configuration file, created by -# sphinx-quickstart on Thu Mar 26 10:47:44 2009. +# Logutils documentation build configuration file, created by +# sphinx-quickstart on Fri Oct 1 15:54:52 2010. # # 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. # @@ -13,16 +16,17 @@ import sys, os -# If extensions (or modules to document with autodoc) are in another directory, +# If your extensions (or modules documented by 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('.')) +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 = ['sphinx.ext.doctest', 'sphinx.ext.coverage'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -37,7 +41,7 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'logutils' +project = u'Logutils' copyright = u'2010, Vinay Sajip' # The version info for the project you're documenting, acts as replacement for @@ -45,9 +49,9 @@ copyright = u'2010, Vinay Sajip' # built documents. # # The short X.Y version. -version = '0.1' +version = '0.2' # The full version, including alpha/beta/rc tags. -release = '0.1' +release = '0.2' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -64,7 +68,7 @@ release = '0.1' # List of directories, relative to source directory, that shouldn't be searched # for source files. -exclude_trees = [] +exclude_trees = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -83,23 +87,14 @@ 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 theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'default' +# Options for HTML output +# ----------------------- -# 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 = [] +# 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' # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". @@ -146,8 +141,8 @@ html_static_path = ['_static'] # 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 # 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 @@ -158,10 +153,11 @@ html_static_path = ['_static'] #html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'logutils' +htmlhelp_basename = 'Logutilsdoc' -# -- Options for LaTeX output -------------------------------------------------- +# Options for LaTeX output +# ------------------------ # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' @@ -170,10 +166,10 @@ htmlhelp_basename = 'logutils' #latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'logutils.tex', u'logutils Documentation', - u'Vinay Sajip', 'manual'), + ('index', 'Logutils.tex', ur'Logutils Documentation', + ur'Vinay Sajip', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -193,6 +189,8 @@ latex_documents = [ # If false, no module index is generated. #latex_use_modindex = True -# Python code that is treated like it were put in a testsetup directive for -# every file that is tested, and for every group. -doctest_global_setup = "import logutils" + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + 'http://docs.python.org/dev': None, +} |