Mercurial > sqlpython
changeset 316:ea0b0e1ab6da
using original conf.py
author | catherine@dellzilla |
---|---|
date | Tue, 31 Mar 2009 09:21:09 -0400 |
parents | a0a36232983a |
children | f200a222a936 |
files | docs/source/conf.py |
diffstat | 1 files changed, 29 insertions(+), 33 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/source/conf.py Tue Mar 31 09:12:30 2009 -0400 +++ b/docs/source/conf.py Tue Mar 31 09:21:09 2009 -0400 @@ -1,10 +1,13 @@ # -*- coding: utf-8 -*- # -# sqlpython documentation build configuration file, created by -# sphinx-quickstart on Sat Mar 28 11:49:41 2009. +# SQLPython documentation build configuration file, created by +# sphinx-quickstart on Wed Mar 4 15:43:28 2009. # # 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,19 +16,20 @@ 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. +# 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. #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 = [] +extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ['.templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -37,7 +41,7 @@ master_doc = 'index' # General information about the project. -project = u'sqlpython' +project = u'SQLPython' copyright = u'2009, Catherine Devlin' # The version info for the project you're documenting, acts as replacement for @@ -47,7 +51,7 @@ # The short X.Y version. version = '1.6' # The full version, including alpha/beta/rc tags. -release = '1.6.2' +release = '1.6.1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -83,23 +87,14 @@ # 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 --------------------------------------------------- +# 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' - -# 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". @@ -120,7 +115,7 @@ # 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. @@ -146,8 +141,8 @@ # 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_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'sqlpythondoc' +htmlhelp_basename = 'SQLPythondoc' -# -- Options for LaTeX output -------------------------------------------------- +# Options for LaTeX output +# ------------------------ # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' @@ -170,10 +166,10 @@ #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', 'sqlpython.tex', u'sqlpython Documentation', - u'Catherine Devlin', 'manual'), + ('index', 'SQLPython.tex', ur'SQLPython Documentation', + ur'Catherine Devlin', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of