source: trunk/docs/source/conf.py @ 2027

Last change on this file since 2027 was 2027, checked in by toby, 6 years ago

duplicate sphinx files for ReadTheDocs? trial

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