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

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

try RTFD build again

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