| 1 |
# BSD Licence |
| 2 |
# Copyright (c) 2011, Science & Technology Facilities Council (STFC) |
| 3 |
# All rights reserved. |
| 4 |
# |
| 5 |
# See the LICENSE file in the source distribution of this software for |
| 6 |
# the full license text. |
| 7 |
|
| 8 |
# -*- coding: utf-8 -*- |
| 9 |
# |
| 10 |
# drslib documentation build configuration file, created by |
| 11 |
# sphinx-quickstart on Thu Jul 8 11:22:21 2010. |
| 12 |
# |
| 13 |
# This file is execfile()d with the current directory set to its containing dir. |
| 14 |
# |
| 15 |
# Note that not all possible configuration values are present in this |
| 16 |
# autogenerated file. |
| 17 |
# |
| 18 |
# All configuration values have a default; values that are commented out |
| 19 |
# serve to show the default. |
| 20 |
|
| 21 |
import sys, os |
| 22 |
|
| 23 |
# If extensions (or modules to document with autodoc) are in another directory, |
| 24 |
# add these directories to sys.path here. If the directory is relative to the |
| 25 |
# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 26 |
#sys.path.append(os.path.abspath('.')) |
| 27 |
|
| 28 |
# -- General configuration ----------------------------------------------------- |
| 29 |
|
| 30 |
# If your documentation needs a minimal Sphinx version, state it here. |
| 31 |
#needs_sphinx = '1.0' |
| 32 |
|
| 33 |
# Add any Sphinx extension module names here, as strings. They can be extensions |
| 34 |
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
| 35 |
extensions = ['sphinx.ext.autodoc', |
| 36 |
# viewcode not working at present |
| 37 |
#'sphinx.ext.viewcode' |
| 38 |
] |
| 39 |
|
| 40 |
# Add any paths that contain templates here, relative to this directory. |
| 41 |
templates_path = ['_templates'] |
| 42 |
|
| 43 |
# The suffix of source filenames. |
| 44 |
source_suffix = '.rst' |
| 45 |
|
| 46 |
# The encoding of source files. |
| 47 |
#source_encoding = 'utf-8-sig' |
| 48 |
|
| 49 |
# The master toctree document. |
| 50 |
master_doc = 'index' |
| 51 |
|
| 52 |
# General information about the project. |
| 53 |
project = u'drslib' |
| 54 |
copyright = u'2010, Stephen Pascoe' |
| 55 |
|
| 56 |
# The version info for the project you're documenting, acts as replacement for |
| 57 |
# |version| and |release|, also used in various other places throughout the |
| 58 |
# built documents. |
| 59 |
# |
| 60 |
# The short X.Y version. |
| 61 |
version = '0.3.1' |
| 62 |
# The full version, including alpha/beta/rc tags. |
| 63 |
release = '0.3.1' |
| 64 |
|
| 65 |
# The language for content autogenerated by Sphinx. Refer to documentation |
| 66 |
# for a list of supported languages. |
| 67 |
#language = None |
| 68 |
|
| 69 |
# There are two options for replacing |today|: either, you set today to some |
| 70 |
# non-false value, then it is used: |
| 71 |
#today = '' |
| 72 |
# Else, today_fmt is used as the format for a strftime call. |
| 73 |
#today_fmt = '%B %d, %Y' |
| 74 |
|
| 75 |
# List of patterns, relative to source directory, that match files and |
| 76 |
# directories to ignore when looking for source files. |
| 77 |
exclude_patterns = ['_build'] |
| 78 |
|
| 79 |
# The reST default role (used for this markup: `text`) to use for all documents. |
| 80 |
#default_role = None |
| 81 |
|
| 82 |
# If true, '()' will be appended to :func: etc. cross-reference text. |
| 83 |
#add_function_parentheses = True |
| 84 |
|
| 85 |
# If true, the current module name will be prepended to all description |
| 86 |
# unit titles (such as .. function::). |
| 87 |
#add_module_names = True |
| 88 |
|
| 89 |
# If true, sectionauthor and moduleauthor directives will be shown in the |
| 90 |
# output. They are ignored by default. |
| 91 |
#show_authors = False |
| 92 |
|
| 93 |
# The name of the Pygments (syntax highlighting) style to use. |
| 94 |
pygments_style = 'sphinx' |
| 95 |
|
| 96 |
# A list of ignored prefixes for module index sorting. |
| 97 |
#modindex_common_prefix = [] |
| 98 |
|
| 99 |
|
| 100 |
# -- Options for HTML output --------------------------------------------------- |
| 101 |
|
| 102 |
# The theme to use for HTML and HTML Help pages. See the documentation for |
| 103 |
# a list of builtin themes. |
| 104 |
#html_theme = 'default' |
| 105 |
#html_theme = 'sphinxdoc' |
| 106 |
html_theme = 'esgf-sphinx-theme' |
| 107 |
|
| 108 |
# Theme options are theme-specific and customize the look and feel of a theme |
| 109 |
# further. For a list of options available for each theme, see the |
| 110 |
# documentation. |
| 111 |
html_theme_options = {'esgf_project': 'drslib'} |
| 112 |
|
| 113 |
# Add any paths that contain custom themes here, relative to this directory. |
| 114 |
html_theme_path = ['.'] |
| 115 |
|
| 116 |
# The name for this set of Sphinx documents. If None, it defaults to |
| 117 |
# "<project> v<release> documentation". |
| 118 |
#html_title = None |
| 119 |
|
| 120 |
# A shorter title for the navigation bar. Default is the same as html_title. |
| 121 |
#html_short_title = None |
| 122 |
|
| 123 |
# The name of an image file (relative to this directory) to place at the top |
| 124 |
# of the sidebar. |
| 125 |
#html_logo = None |
| 126 |
|
| 127 |
# The name of an image file (within the static path) to use as favicon of the |
| 128 |
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
| 129 |
# pixels large. |
| 130 |
#html_favicon = None |
| 131 |
|
| 132 |
# Add any paths that contain custom static files (such as style sheets) here, |
| 133 |
# relative to this directory. They are copied after the builtin static files, |
| 134 |
# so a file named "default.css" will overwrite the builtin "default.css". |
| 135 |
html_static_path = ['_static'] |
| 136 |
|
| 137 |
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
| 138 |
# using the given strftime format. |
| 139 |
#html_last_updated_fmt = '%b %d, %Y' |
| 140 |
|
| 141 |
# If true, SmartyPants will be used to convert quotes and dashes to |
| 142 |
# typographically correct entities. |
| 143 |
#html_use_smartypants = True |
| 144 |
|
| 145 |
# Custom sidebar templates, maps document names to template names. |
| 146 |
#html_sidebars = {} |
| 147 |
|
| 148 |
# Additional templates that should be rendered to pages, maps page names to |
| 149 |
# template names. |
| 150 |
#html_additional_pages = {} |
| 151 |
|
| 152 |
# If false, no module index is generated. |
| 153 |
#html_domain_indices = True |
| 154 |
|
| 155 |
# If false, no index is generated. |
| 156 |
#html_use_index = True |
| 157 |
|
| 158 |
# If true, the index is split into individual pages for each letter. |
| 159 |
#html_split_index = False |
| 160 |
|
| 161 |
# If true, links to the reST sources are added to the pages. |
| 162 |
#html_show_sourcelink = True |
| 163 |
|
| 164 |
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
| 165 |
#html_show_sphinx = True |
| 166 |
|
| 167 |
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
| 168 |
#html_show_copyright = True |
| 169 |
|
| 170 |
# If true, an OpenSearch description file will be output, and all pages will |
| 171 |
# contain a <link> tag referring to it. The value of this option must be the |
| 172 |
# base URL from which the finished HTML is served. |
| 173 |
#html_use_opensearch = '' |
| 174 |
|
| 175 |
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
| 176 |
#html_file_suffix = '' |
| 177 |
|
| 178 |
# Output file base name for HTML help builder. |
| 179 |
htmlhelp_basename = 'drslibdoc' |
| 180 |
|
| 181 |
|
| 182 |
# -- Options for LaTeX output -------------------------------------------------- |
| 183 |
|
| 184 |
# The paper size ('letter' or 'a4'). |
| 185 |
#latex_paper_size = 'letter' |
| 186 |
|
| 187 |
# The font size ('10pt', '11pt' or '12pt'). |
| 188 |
#latex_font_size = '10pt' |
| 189 |
|
| 190 |
# Grouping the document tree into LaTeX files. List of tuples |
| 191 |
# (source start file, target name, title, author, documentclass [howto/manual]). |
| 192 |
latex_documents = [ |
| 193 |
('index', 'drslib.tex', u'drslib Documentation', |
| 194 |
u'Stephen Pascoe', 'manual'), |
| 195 |
] |
| 196 |
|
| 197 |
# The name of an image file (relative to this directory) to place at the top of |
| 198 |
# the title page. |
| 199 |
#latex_logo = None |
| 200 |
|
| 201 |
# For "manual" documents, if this is true, then toplevel headings are parts, |
| 202 |
# not chapters. |
| 203 |
#latex_use_parts = False |
| 204 |
|
| 205 |
# If true, show page references after internal links. |
| 206 |
#latex_show_pagerefs = False |
| 207 |
|
| 208 |
# If true, show URL addresses after external links. |
| 209 |
#latex_show_urls = False |
| 210 |
|
| 211 |
# Additional stuff for the LaTeX preamble. |
| 212 |
#latex_preamble = '' |
| 213 |
|
| 214 |
# Documents to append as an appendix to all manuals. |
| 215 |
#latex_appendices = [] |
| 216 |
|
| 217 |
# If false, no module index is generated. |
| 218 |
#latex_domain_indices = True |
| 219 |
|
| 220 |
|
| 221 |
# -- Options for manual page output -------------------------------------------- |
| 222 |
|
| 223 |
# One entry per manual page. List of tuples |
| 224 |
# (source start file, name, description, authors, manual section). |
| 225 |
man_pages = [ |
| 226 |
('index', 'drslib', u'drslib Documentation', |
| 227 |
[u'Stephen Pascoe'], 1) |
| 228 |
] |