@@ -0,0 +1,258 @@
1+# -*- coding: utf-8 -*-
3+# PureScript documentation build configuration file, created by
4+# sphinx-quickstart on Wed Jan 22 22:04:23 2014.
6+# This file is execfile()d with the current directory set to its
9+# Note that not all possible configuration values are present in this
12+# All configuration values have a default; values that are commented out
13+# serve to show the default.
18+# If extensions (or modules to document with autodoc) are in another directory,
19+# add these directories to sys.path here. If the directory is relative to the
20+# documentation root, use os.path.abspath to make it absolute, like shown here.
21+#sys.path.insert(0, os.path.abspath('.'))
23+# -- General configuration ------------------------------------------------
25+# If your documentation needs a minimal Sphinx version, state it here.
28+# Add any Sphinx extension module names here, as strings. They can be
29+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33+# Add any paths that contain templates here, relative to this directory.
34+templates_path = ['_templates']
36+# The suffix of source filenames.
37+source_suffix = '.rst'
39+# The encoding of source files.
40+#source_encoding = 'utf-8-sig'
42+# The master toctree document.
45+# General information about the project.
46+project = u'PureScript'
47+copyright = u'2014, Phil Freeman'
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
53+# The short X.Y version.
55+# The full version, including alpha/beta/rc tags.
58+# The language for content autogenerated by Sphinx. Refer to documentation
59+# for a list of supported languages.
62+# There are two options for replacing |today|: either, you set today to some
63+# non-false value, then it is used:
65+# Else, today_fmt is used as the format for a strftime call.
66+#today_fmt = '%B %d, %Y'
68+# List of patterns, relative to source directory, that match files and
69+# directories to ignore when looking for source files.
72+# The reST default role (used for this markup: `text`) to use for all
76+# If true, '()' will be appended to :func: etc. cross-reference text.
77+#add_function_parentheses = True
79+# If true, the current module name will be prepended to all description
80+# unit titles (such as .. function::).
81+#add_module_names = True
83+# If true, sectionauthor and moduleauthor directives will be shown in the
84+# output. They are ignored by default.
87+# The name of the Pygments (syntax highlighting) style to use.
88+pygments_style = 'sphinx'
90+# A list of ignored prefixes for module index sorting.
91+#modindex_common_prefix = []
93+# If true, keep warnings as "system message" paragraphs in the built documents.
94+#keep_warnings = False
97+# -- Options for HTML output ----------------------------------------------
99+# The theme to use for HTML and HTML Help pages. See the documentation for
100+# a list of builtin themes.
101+html_theme = 'default'
103+# Theme options are theme-specific and customize the look and feel of a theme
104+# further. For a list of options available for each theme, see the
106+#html_theme_options = {}
108+# Add any paths that contain custom themes here, relative to this directory.
109+#html_theme_path = []
111+# The name for this set of Sphinx documents. If None, it defaults to
112+# "<project> v<release> documentation".
115+# A shorter title for the navigation bar. Default is the same as html_title.
116+#html_short_title = None
118+# The name of an image file (relative to this directory) to place at the top
122+# The name of an image file (within the static path) to use as favicon of the
123+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
127+# Add any paths that contain custom static files (such as style sheets) here,
128+# relative to this directory. They are copied after the builtin static files,
129+# so a file named "default.css" will overwrite the builtin "default.css".
130+html_static_path = ['_static']
132+# Add any extra paths that contain custom files (such as robots.txt or
133+# .htaccess) here, relative to this directory. These files are copied
134+# directly to the root of the documentation.
135+#html_extra_path = []
137+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
138+# using the given strftime format.
139+#html_last_updated_fmt = '%b %d, %Y'
141+# If true, SmartyPants will be used to convert quotes and dashes to
142+# typographically correct entities.
143+#html_use_smartypants = True
145+# Custom sidebar templates, maps document names to template names.
148+# Additional templates that should be rendered to pages, maps page names to
150+#html_additional_pages = {}
152+# If false, no module index is generated.
153+#html_domain_indices = True
155+# If false, no index is generated.
156+#html_use_index = True
158+# If true, the index is split into individual pages for each letter.
159+#html_split_index = False
161+# If true, links to the reST sources are added to the pages.
162+#html_show_sourcelink = True
164+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
165+#html_show_sphinx = True
167+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
168+#html_show_copyright = True
170+# If true, an OpenSearch description file will be output, and all pages will
171+# contain a <link> tag referring to it. The value of this option must be the
172+# base URL from which the finished HTML is served.
173+#html_use_opensearch = ''
175+# This is the file name suffix for HTML files (e.g. ".xhtml").
176+#html_file_suffix = None
178+# Output file base name for HTML help builder.
179+htmlhelp_basename = 'PureScriptdoc'
182+# -- Options for LaTeX output ---------------------------------------------
185+# The paper size ('letterpaper' or 'a4paper').
186+#'papersize': 'letterpaper',
188+# The font size ('10pt', '11pt' or '12pt').
189+#'pointsize': '10pt',
191+# Additional stuff for the LaTeX preamble.
195+# Grouping the document tree into LaTeX files. List of tuples
196+# (source start file, target name, title,
197+# author, documentclass [howto, manual, or own class]).
199+ ('index', 'PureScript.tex', u'PureScript Documentation',
200+ u'Phil Freeman', 'manual'),
203+# The name of an image file (relative to this directory) to place at the top of
207+# For "manual" documents, if this is true, then toplevel headings are parts,
209+#latex_use_parts = False
211+# If true, show page references after internal links.
212+#latex_show_pagerefs = False
214+# If true, show URL addresses after external links.
215+#latex_show_urls = False
217+# Documents to append as an appendix to all manuals.
218+#latex_appendices = []
220+# If false, no module index is generated.
221+#latex_domain_indices = True
224+# -- Options for manual page output ---------------------------------------
226+# One entry per manual page. List of tuples
227+# (source start file, name, description, authors, manual section).
229+ ('index', 'purescript', u'PureScript Documentation',
230+ [u'Phil Freeman'], 1)
233+# If true, show URL addresses after external links.
234+#man_show_urls = False
237+# -- Options for Texinfo output -------------------------------------------
239+# Grouping the document tree into Texinfo files. List of tuples
240+# (source start file, target name, title, author,
241+# dir menu entry, description, category)
242+texinfo_documents = [
243+ ('index', 'PureScript', u'PureScript Documentation',
244+ u'Phil Freeman', 'PureScript', 'One line description of project.',
248+# Documents to append as an appendix to all manuals.
249+#texinfo_appendices = []
251+# If false, no module index is generated.
252+#texinfo_domain_indices = True
254+# How to display URL addresses: 'footnote', 'no', or 'inline'.
255+#texinfo_show_urls = 'footnote'
257+# If true, do not generate a @detailmenu in the "Top" node's menu.
258+#texinfo_no_detailmenu = False