Back to index

python-cliapp  1.20120630
conf.py
Go to the documentation of this file.
00001 # -*- coding: utf-8 -*-
00002 #
00003 # cliapp documentation build configuration file, created by
00004 # sphinx-quickstart on Sun May 29 13:50:03 2011.
00005 #
00006 # This file is execfile()d with the current directory set to its containing dir.
00007 #
00008 # Note that not all possible configuration values are present in this
00009 # autogenerated file.
00010 #
00011 # All configuration values have a default; values that are commented out
00012 # serve to show the default.
00013 
00014 import sys, os
00015 
00016 # If extensions (or modules to document with autodoc) are in another directory,
00017 # add these directories to sys.path here. If the directory is relative to the
00018 # documentation root, use os.path.abspath to make it absolute, like shown here.
00019 sys.path.insert(0, os.path.abspath('..'))
00020 
00021 import cliapp
00022 
00023 # -- General configuration -----------------------------------------------------
00024 
00025 # Add any Sphinx extension module names here, as strings. They can be extensions
00026 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
00027 extensions = ['sphinx.ext.autodoc']
00028 
00029 # Add any paths that contain templates here, relative to this directory.
00030 templates_path = ['_templates']
00031 
00032 # The suffix of source filenames.
00033 source_suffix = '.rst'
00034 
00035 # The encoding of source files.
00036 #source_encoding = 'utf-8'
00037 
00038 # The master toctree document.
00039 master_doc = 'index'
00040 
00041 # General information about the project.
00042 project = u'cliapp'
00043 copyright = u'2011, Lars Wirzenius'
00044 
00045 # The version info for the project you're documenting, acts as replacement for
00046 # |version| and |release|, also used in various other places throughout the
00047 # built documents.
00048 #
00049 # The short X.Y version.
00050 version = cliapp.__version__
00051 # The full version, including alpha/beta/rc tags.
00052 release = version
00053 
00054 # The language for content autogenerated by Sphinx. Refer to documentation
00055 # for a list of supported languages.
00056 #language = None
00057 
00058 # There are two options for replacing |today|: either, you set today to some
00059 # non-false value, then it is used:
00060 #today = ''
00061 # Else, today_fmt is used as the format for a strftime call.
00062 #today_fmt = '%B %d, %Y'
00063 
00064 # List of documents that shouldn't be included in the build.
00065 #unused_docs = []
00066 
00067 # List of directories, relative to source directory, that shouldn't be searched
00068 # for source files.
00069 exclude_trees = ['_build']
00070 
00071 # The reST default role (used for this markup: `text`) to use for all documents.
00072 #default_role = None
00073 
00074 # If true, '()' will be appended to :func: etc. cross-reference text.
00075 #add_function_parentheses = True
00076 
00077 # If true, the current module name will be prepended to all description
00078 # unit titles (such as .. function::).
00079 #add_module_names = True
00080 
00081 # If true, sectionauthor and moduleauthor directives will be shown in the
00082 # output. They are ignored by default.
00083 #show_authors = False
00084 
00085 # The name of the Pygments (syntax highlighting) style to use.
00086 pygments_style = 'sphinx'
00087 
00088 # A list of ignored prefixes for module index sorting.
00089 #modindex_common_prefix = []
00090 
00091 
00092 # -- Options for HTML output ---------------------------------------------------
00093 
00094 # The theme to use for HTML and HTML Help pages.  Major themes that come with
00095 # Sphinx are currently 'default' and 'sphinxdoc'.
00096 html_theme = 'default'
00097 
00098 # Theme options are theme-specific and customize the look and feel of a theme
00099 # further.  For a list of options available for each theme, see the
00100 # documentation.
00101 #html_theme_options = {}
00102 
00103 # Add any paths that contain custom themes here, relative to this directory.
00104 #html_theme_path = []
00105 
00106 # The name for this set of Sphinx documents.  If None, it defaults to
00107 # "<project> v<release> documentation".
00108 #html_title = None
00109 
00110 # A shorter title for the navigation bar.  Default is the same as html_title.
00111 #html_short_title = None
00112 
00113 # The name of an image file (relative to this directory) to place at the top
00114 # of the sidebar.
00115 #html_logo = None
00116 
00117 # The name of an image file (within the static path) to use as favicon of the
00118 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
00119 # pixels large.
00120 #html_favicon = None
00121 
00122 # Add any paths that contain custom static files (such as style sheets) here,
00123 # relative to this directory. They are copied after the builtin static files,
00124 # so a file named "default.css" will overwrite the builtin "default.css".
00125 html_static_path = ['_static']
00126 
00127 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
00128 # using the given strftime format.
00129 #html_last_updated_fmt = '%b %d, %Y'
00130 
00131 # If true, SmartyPants will be used to convert quotes and dashes to
00132 # typographically correct entities.
00133 #html_use_smartypants = True
00134 
00135 # Custom sidebar templates, maps document names to template names.
00136 #html_sidebars = {}
00137 
00138 # Additional templates that should be rendered to pages, maps page names to
00139 # template names.
00140 #html_additional_pages = {}
00141 
00142 # If false, no module index is generated.
00143 #html_use_modindex = True
00144 
00145 # If false, no index is generated.
00146 #html_use_index = True
00147 
00148 # If true, the index is split into individual pages for each letter.
00149 #html_split_index = False
00150 
00151 # If true, links to the reST sources are added to the pages.
00152 #html_show_sourcelink = True
00153 
00154 # If true, an OpenSearch description file will be output, and all pages will
00155 # contain a <link> tag referring to it.  The value of this option must be the
00156 # base URL from which the finished HTML is served.
00157 #html_use_opensearch = ''
00158 
00159 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
00160 #html_file_suffix = ''
00161 
00162 # Output file base name for HTML help builder.
00163 htmlhelp_basename = 'cliappdoc'
00164 
00165 
00166 # -- Options for LaTeX output --------------------------------------------------
00167 
00168 # The paper size ('letter' or 'a4').
00169 #latex_paper_size = 'letter'
00170 
00171 # The font size ('10pt', '11pt' or '12pt').
00172 #latex_font_size = '10pt'
00173 
00174 # Grouping the document tree into LaTeX files. List of tuples
00175 # (source start file, target name, title, author, documentclass [howto/manual]).
00176 latex_documents = [
00177   ('index', 'cliapp.tex', u'cliapp Documentation',
00178    u'Lars Wirzenius', 'manual'),
00179 ]
00180 
00181 # The name of an image file (relative to this directory) to place at the top of
00182 # the title page.
00183 #latex_logo = None
00184 
00185 # For "manual" documents, if this is true, then toplevel headings are parts,
00186 # not chapters.
00187 #latex_use_parts = False
00188 
00189 # Additional stuff for the LaTeX preamble.
00190 #latex_preamble = ''
00191 
00192 # Documents to append as an appendix to all manuals.
00193 #latex_appendices = []
00194 
00195 # If false, no module index is generated.
00196 #latex_use_modindex = True