source: mauRepo/MolesManager/trunk/docs/source/conf.py @ 8537

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/mauRepo/MolesManager/trunk/docs/source/conf.py@8537
Revision 8537, 6.8 KB checked in by mnagni, 7 years ago (diff)

Incomplete - # 22528: Migration of FAtCat Open Search link for HPFeld
 http://team.ceda.ac.uk/trac/ceda/ticket/22528

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