1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
|
# -*- coding: utf-8 -*-
#
# Sphinx documentation build configuration file
import sys, os, re
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.addons.*') or your custom ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['../_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'contents'
# List of documents that shouldn't be included in the build.
unused_docs = ['index', 'tclgui', 'helpwanted', 'platform', 'examples',
'limitations', 'verilog', 'manual', 'copyright', 'build']
# General substitutions.
project = 'Simulavr'
copyright = '2004-2012, Bill Rivet, Thomas Klepp'
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
# The full version, including alpha/beta/rc tags.
release = '@VERSION@'
# The short X.Y version.
version = re.match(r"(\d+\.\d+)*", release).group(1)
# Show author directives in the output.
show_authors = True
# The HTML template theme.
html_theme = 'sphinxdoc'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Simulavr homepage'
# A list of ignored prefixes names for module index sorting.
modindex_common_prefix = ['sphinx.']
# 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.
html_last_updated_fmt = '%b %d, %Y'
# Content template for the index page.
html_index = 'index.html'
# Custom sidebar templates, maps page names to templates.
html_sidebars = {'index': 'indexsidebar.html'}
# Additional templates that should be rendered to pages, maps page names to
# templates.
html_additional_pages = {'index': 'index.html'}
# If false, no index is generated.
html_use_index = False
# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False
# Put TODOs into the output.
#todo_include_todos = True
|