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