3# Idris Manual documentation build configuration file, created by
4# sphinx-quickstart on Sat Feb 28 20:41:47 2015.
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# True if the readthedocs theme is locally installed
19on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
21# If extensions (or modules to document with autodoc) are in another directory,
22# add these directories to sys.path here. If the directory is relative to the
23# documentation root, use os.path.abspath to make it absolute, like shown here.
24#sys.path.insert(0, os.path.abspath('.'))
26# -- General configuration ------------------------------------------------
28# If your documentation needs a minimal Sphinx version, state it here.
31# Add any Sphinx extension module names here, as strings. They can be
32# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
37 'sphinx.ext.ifconfig',
40# Add any paths that contain templates here, relative to this directory.
41templates_path = ['_templates']
43# The suffix of source filenames.
46# The encoding of source files.
47#source_encoding = 'utf-8-sig'
49# The master toctree document.
52# General information about the project.
54copyright = u'2015, The Idris Community'
55author = u'The Idris Community'
57# The version info for the project you're documenting, acts as replacement for
58# |version| and |release|, also used in various other places throughout the
61# The short X.Y version.
63# The full version, including alpha/beta/rc tags.
66# The language for content autogenerated by Sphinx. Refer to documentation
67# for a list of supported languages.
69# This is also used if you do content translation via gettext catalogs.
70# Usually you set "language" from the command line for these cases.
73# There are two options for replacing |today|: either, you set today to some
74# non-false value, then it is used:
76# Else, today_fmt is used as the format for a strftime call.
77#today_fmt = '%B %d, %Y'
79# List of patterns, relative to source directory, that match files and
80# directories to ignore when looking for source files.
81exclude_patterns = ['_build']
83# The reST default role (used for this markup: `text`) to use for all
87# If true, '()' will be appended to :func: etc. cross-reference text.
88#add_function_parentheses = True
90# If true, the current module name will be prepended to all description
91# unit titles (such as .. function::).
92#add_module_names = True
94# If true, sectionauthor and moduleauthor directives will be shown in the
95# output. They are ignored by default.
98# The name of the Pygments (syntax highlighting) style to use.
99pygments_style = 'sphinx'
101# A list of ignored prefixes for module index sorting.
102#modindex_common_prefix = []
104# If true, keep warnings as "system message" paragraphs in the built documents.
105#keep_warnings = False
107# If true, `todo` and `todoList` produce output, else they produce nothing.
108todo_include_todos = True
111# -- Options for HTML output ----------------------------------------------
113# The theme to use for HTML and HTML Help pages. See the documentation for
114# a list of builtin themes.
115html_theme = "default"
117if not on_rtd: # only import and set the theme if we're building docs locally
119 import sphinx_rtd_theme
120 html_theme = 'sphinx_rtd_theme'
121 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
123 html_theme = "default"
125# Theme options are theme-specific and customize the look and feel of a theme
126# further. For a list of options available for each theme, see the
128#html_theme_options = {}
130# Add any paths that contain custom themes here, relative to this directory.
133# The name for this set of Sphinx documents. If None, it defaults to
134# "<project> v<release> documentation".
137# A shorter title for the navigation bar. Default is the same as html_title.
138#html_short_title = None
140# The name of an image file (relative to this directory) to place at the top
144# The name of an image file (within the static path) to use as favicon of the
145# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
149# Add any paths that contain custom static files (such as style sheets) here,
150# relative to this directory. They are copied after the builtin static files,
151# so a file named "default.css" will overwrite the builtin "default.css".
152html_static_path = ['_static']
154# Add any extra paths that contain custom files (such as robots.txt or
155# .htaccess) here, relative to this directory. These files are copied
156# directly to the root of the documentation.
159# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
160# using the given strftime format.
161#html_last_updated_fmt = '%b %d, %Y'
163# If true, SmartyPants will be used to convert quotes and dashes to
164# typographically correct entities.
165#html_use_smartypants = True
167# Custom sidebar templates, maps document names to template names.
170# Additional templates that should be rendered to pages, maps page names to
172#html_additional_pages = {}
174# If false, no module index is generated.
175#html_domain_indices = True
177# If false, no index is generated.
178#html_use_index = True
180# If true, the index is split into individual pages for each letter.
181#html_split_index = False
183# If true, links to the reST sources are added to the pages.
184#html_show_sourcelink = True
186# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
187#html_show_sphinx = True
189# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
190#html_show_copyright = True
192# If true, an OpenSearch description file will be output, and all pages will
193# contain a <link> tag referring to it. The value of this option must be the
194# base URL from which the finished HTML is served.
195#html_use_opensearch = ''
197# This is the file name suffix for HTML files (e.g. ".xhtml").
198#html_file_suffix = None
200# Language to be used for generating the HTML full-text search index.
201# Sphinx supports the following languages:
202# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
203# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
204#html_search_language = 'en'
206# A dictionary with options for the search language support, empty by default.
207# Now only 'ja' uses this config value
208#html_search_options = {'type': 'default'}
210# The name of a javascript file (relative to the configuration directory) that
211# implements a search results scorer. If empty, the default will be used.
212#html_search_scorer = 'scorer.js'
214# Output file base name for HTML help builder.
215htmlhelp_basename = 'IdrisManualdoc'
217# -- Options for LaTeX output ---------------------------------------------
220# The paper size ('letterpaper' or 'a4paper').
221'papersize': 'a4paper',
223# The font size ('10pt', '11pt' or '12pt').
226# Additional stuff for the LaTeX preamble.
229# Latex figure (float) alignment
230#'figure_align': 'htbp',
233# Grouping the document tree into LaTeX files. List of tuples
234# (source start file, target name, title,
235# author, documentclass [howto, manual, or own class]).
237 ('tutorial/index', 'idris-tutorial.tex', u'The Idris Tutorial', u'The Idris Community', 'manual'),
238 ('guides/index', 'idris-guides.tex', u'Idris Tutorial Series', u'The Idris Community', 'manual'),
239# ('reference/index', 'idris-reference.tex', u'The Idris Reference', u'The Idris Community', 'manual'),
240 ('effects/index', 'eff-tutorial.tex', u'The Effects Tutorial', u'The Idris Community', 'manual')
243# The name of an image file (relative to this directory) to place at the top of
247# For "manual" documents, if this is true, then toplevel headings are parts,
249#latex_use_parts = True
251# If true, show page references after internal links.
252#latex_show_pagerefs = False
254# If true, show URL addresses after external links.
255#latex_show_urls = False
257# Documents to append as an appendix to all manuals.
258#latex_appendices = []
260# If false, no module index is generated.
261#latex_domain_indices = True
264# -- Options for manual page output ---------------------------------------
266# One entry per manual page. List of tuples
267# (source start file, name, description, authors, manual section).
269 (master_doc, 'idrismanual', u'Idris Manual Documentation',
273# If true, show URL addresses after external links.
274#man_show_urls = False
277# -- Options for Texinfo output -------------------------------------------
279# Grouping the document tree into Texinfo files. List of tuples
280# (source start file, target name, title, author,
281# dir menu entry, description, category)
283 (master_doc, 'IdrisManual', u'Idris Manual Documentation',
284 author, 'IdrisManual', 'One line description of project.',
288# Documents to append as an appendix to all manuals.
289#texinfo_appendices = []
291# If false, no module index is generated.
292#texinfo_domain_indices = True
294# How to display URL addresses: 'footnote', 'no', or 'inline'.
295#texinfo_show_urls = 'footnote'
297# If true, do not generate a @detailmenu in the "Top" node's menu.
298#texinfo_no_detailmenu = False
301# -- Options for Epub output ----------------------------------------------
303# Bibliographic Dublin Core info.
306epub_publisher = author
307epub_copyright = copyright
309# The basename for the epub file. It defaults to the project name.
310#epub_basename = project
312# The HTML theme for the epub output. Since the default themes are not optimized
313# for small screen space, using the same theme for HTML and epub output is
314# usually not wise. This defaults to 'epub', a theme designed to save visual
318# The language of the text. It defaults to the language option
319# or 'en' if the language is not set.
322# The scheme of the identifier. Typical schemes are ISBN or URL.
325# The unique identifier of the text. This can be a ISBN number
326# or the project homepage.
329# A unique identification for the text.
332# A tuple containing the cover image and cover page html template filenames.
335# A sequence of (type, uri, title) tuples for the guide element of content.opf.
338# HTML files that should be inserted before the pages created by sphinx.
339# The format is a list of tuples containing the path and title.
342# HTML files shat should be inserted after the pages created by sphinx.
343# The format is a list of tuples containing the path and title.
346# A list of files that should not be packed into the epub file.
347epub_exclude_files = ['search.html']
349# The depth of the table of contents in toc.ncx.
352# Allow duplicate toc entries.
355# Choose between 'default' and 'includehidden'.
356#epub_tocscope = 'default'
358# Fix unsupported image types using the Pillow.
359#epub_fix_images = False
362#epub_max_image_width = 0
364# How to display URL addresses: 'footnote', 'no', or 'inline'.
365#epub_show_urls = 'inline'
367# If false, no index is generated.
368#epub_use_index = True
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list