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

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

try RTFD build again

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