Project

General

Profile

metacat / docs / user / metacat / source / conf.py @ 9854

1
# -*- 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
source_suffix = '.rst'
32

    
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
copyright = u'2012, Regents of the University of California'
42

    
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
version = '2.8'
49
# The full version, including alpha/beta/rc tags.
50
release = '2.8.0'
51

    
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

    
87
# A list of ignored prefixes for module index sorting.
88
#modindex_common_prefix = []
89

    
90

    
91
# -- Options for HTML output ---------------------------------------------------
92

    
93
# The theme to use for HTML and HTML Help pages.  Major themes that come with
94
# Sphinx are currently 'default' and 'sphinxdoc'.
95
#html_theme = 'default'
96
html_theme = 'metacatui'
97

    
98
# Theme options are theme-specific and customize the look and feel of a theme
99
# further.  For a list of options available for each theme, see the
100
# documentation.
101
#html_theme_options = {}
102

    
103
# Add any paths that contain custom themes here, relative to this directory.
104
html_theme_path = ['themes',]
105

    
106
# The name for this set of Sphinx documents.  If None, it defaults to
107
# "<project> v<release> documentation".
108
#html_title = None
109

    
110
# A shorter title for the navigation bar.  Default is the same as html_title.
111
#html_short_title = None
112

    
113
# The name of an image file (relative to this directory) to place at the top
114
# of the sidebar.
115
#html_logo = None
116

    
117
# The name of an image file (within the static path) to use as favicon of the
118
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
119
# pixels large.
120
#html_favicon = None
121

    
122
# Add any paths that contain custom static files (such as style sheets) here,
123
# relative to this directory. They are copied after the builtin static files,
124
# so a file named "default.css" will overwrite the builtin "default.css".
125
html_static_path = ['_static']
126

    
127
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128
# using the given strftime format.
129
#html_last_updated_fmt = '%b %d, %Y'
130

    
131
# If true, SmartyPants will be used to convert quotes and dashes to
132
# typographically correct entities.
133
#html_use_smartypants = True
134

    
135
# Custom sidebar templates, maps document names to template names.
136
#html_sidebars = {}
137

    
138
# Additional templates that should be rendered to pages, maps page names to
139
# template names.
140
#html_additional_pages = {}
141

    
142
# If false, no module index is generated.
143
html_use_modindex = False
144
html_domain_indices = False
145

    
146
# If false, no index is generated.
147
#html_use_index = True
148

    
149
# If true, the index is split into individual pages for each letter.
150
#html_split_index = False
151

    
152
# If true, links to the reST sources are added to the pages.
153
#html_show_sourcelink = True
154

    
155
# If true, an OpenSearch description file will be output, and all pages will
156
# contain a <link> tag referring to it.  The value of this option must be the
157
# base URL from which the finished HTML is served.
158
#html_use_opensearch = ''
159

    
160
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
161
#html_file_suffix = ''
162

    
163
# Output file base name for HTML help builder.
164
htmlhelp_basename = 'Metacatdoc'
165

    
166

    
167

    
168
# -- Options for LaTeX output --------------------------------------------------
169

    
170
# The paper size ('letter' or 'a4').
171
#latex_paper_size = 'letter'
172

    
173
# The font size ('10pt', '11pt' or '12pt').
174
#latex_font_size = '10pt'
175

    
176
# Grouping the document tree into LaTeX files. List of tuples
177
# (source start file, target name, title, author, documentclass [howto/manual]).
178
latex_documents = [
179
  ('index', 'Metacat.tex', u'Metacat Documentation',
180
   u'Matthew B. Jones', 'manual'),
181
]
182

    
183
# The name of an image file (relative to this directory) to place at the top of
184
# the title page.
185
#latex_logo = None
186

    
187
# For "manual" documents, if this is true, then toplevel headings are parts,
188
# not chapters.
189
#latex_use_parts = False
190

    
191
# Additional stuff for the LaTeX preamble.
192
#latex_preamble = ''
193

    
194
# Documents to append as an appendix to all manuals.
195
#latex_appendices = []
196

    
197
# If false, no module index is generated.
198
#latex_use_modindex = True
199

    
200
#The format for the reference of 'date'. Format is Month,Year.
201
today_fmt = '%B, %Y'