conf.py 9.74 KB
Newer Older
1
2
3
##############################################################################
# Copyright (c) 2013, Lawrence Livermore National Security, LLC.
# Produced at the Lawrence Livermore National Laboratory.
4
#
5
6
7
# This file is part of Spack.
# Written by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
# LLNL-CODE-647188
8
#
9
# For details, see https://github.com/llnl/spack
10
# Please also see the LICENSE file for our notice and the LGPL.
11
#
12
13
14
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License (as published by
# the Free Software Foundation) version 2.1 dated February 1999.
15
#
16
17
18
19
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
# conditions of the GNU General Public License for more details.
20
#
21
22
23
24
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
Todd Gamblin's avatar
Todd Gamblin committed
25
26
27
28
29
30
31
32
33
34
35
36
37
# -*- coding: utf-8 -*-
#
# Spack documentation build configuration file, created by
# sphinx-quickstart on Mon Dec  9 15:32:41 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

Todd Gamblin's avatar
Todd Gamblin committed
38
39
40
import sys
import os
import subprocess
Todd Gamblin's avatar
Todd Gamblin committed
41
42
43
44

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Todd Gamblin's avatar
Todd Gamblin committed
45
sys.path.insert(0, os.path.abspath('exts'))
Todd Gamblin's avatar
Todd Gamblin committed
46
47

# Add the Spack bin directory to the path so that we can use its output in docs.
Todd Gamblin's avatar
Todd Gamblin committed
48
49
spack_root = '../../..'
os.environ['SPACK_ROOT'] = spack_root
Todd Gamblin's avatar
Todd Gamblin committed
50
os.environ['PATH'] += os.pathsep + '$SPACK_ROOT/bin'
Todd Gamblin's avatar
Todd Gamblin committed
51

Todd Gamblin's avatar
Todd Gamblin committed
52
53
54
spack_version =  subprocess.Popen(
    ['spack', '-V'], stderr=subprocess.PIPE).communicate()[1].strip().split('.')

Todd Gamblin's avatar
Todd Gamblin committed
55
56
# Set an environment variable so that colify will print output like it would to
# a terminal.
57
os.environ['COLIFY_SIZE'] = '25x80'
Todd Gamblin's avatar
Todd Gamblin committed
58
59

# Enable todo items
Todd Gamblin's avatar
Todd Gamblin committed
60
todo_include_todos = True
Todd Gamblin's avatar
Todd Gamblin committed
61
62
63
64
65
66
67
68

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
Todd Gamblin's avatar
Todd Gamblin committed
69
70
71
72
extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.graphviz',
              'sphinx.ext.todo',
              'sphinxcontrib.programoutput']
Todd Gamblin's avatar
Todd Gamblin committed
73

Todd Gamblin's avatar
Todd Gamblin committed
74
75
76
77
78
79
80
81
82
# Set default graphviz options
graphviz_dot_args = [
    '-Grankdir=LR', '-Gbgcolor=transparent',
    '-Nshape=box', '-Nfontname=monaco', '-Nfontsize=10']

# Get nice vector graphics
graphviz_output_format = "svg"


Todd Gamblin's avatar
Todd Gamblin committed
83
84
85
86
87
88
89
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
90
source_encoding = 'utf-8-sig'
Todd Gamblin's avatar
Todd Gamblin committed
91
92
93
94
95
96

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Spack'
Todd Gamblin's avatar
Todd Gamblin committed
97
copyright = u'2013-2015, Lawrence Livermore National Laboratory.'
Todd Gamblin's avatar
Todd Gamblin committed
98
99
100
101
102
103

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
Todd Gamblin's avatar
Todd Gamblin committed
104
version = '.'.join(spack_version[:2])
Todd Gamblin's avatar
Todd Gamblin committed
105
# The full version, including alpha/beta/rc tags.
Todd Gamblin's avatar
Todd Gamblin committed
106
release = '.'.join(spack_version[:2])
Todd Gamblin's avatar
Todd Gamblin committed
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
Todd Gamblin's avatar
Todd Gamblin committed
152
html_theme_options = { 'logo_only' : True }
Todd Gamblin's avatar
Todd Gamblin committed
153
154
155
156
157
158
159
160
161
162
163
164
165

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ["_themes"]

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
Todd Gamblin's avatar
Todd Gamblin committed
166
html_logo = '../../../share/spack/logo/spack-logo-white-text-48.png'
Todd Gamblin's avatar
Todd Gamblin committed
167
168
169
170

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
Todd Gamblin's avatar
Todd Gamblin committed
171
html_favicon = '../../../share/spack/logo/favicon.ico'
Todd Gamblin's avatar
Todd Gamblin committed
172
173
174
175
176
177
178
179

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Todd Gamblin's avatar
Todd Gamblin committed
180
html_last_updated_fmt = '%b %d, %Y'
Todd Gamblin's avatar
Todd Gamblin committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
Todd Gamblin's avatar
Todd Gamblin committed
206
#html_show_sphinx = False
Todd Gamblin's avatar
Todd Gamblin committed
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'Spackdoc'


# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
  ('index', 'Spack.tex', u'Spack Documentation',
   u'Todd Gamblin', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'spack', u'Spack Documentation',
     [u'Todd Gamblin'], 1)
]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
  ('index', 'Spack', u'Spack Documentation',
   u'Todd Gamblin', 'Spack', 'One line description of project.',
   'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'