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

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

try RTFD build again

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