boomslang: docs/conf.py annotate

annotate docs/conf.py @ 854:79b5c1be9a5e default tip

Remove pyntnclick, it's its own library, now

author	Stefano Rivera <stefano@rivera.za.net>
date	Sat, 21 Jun 2014 22:06:09 +0200
parents	0740f6a537ea
children

rev	line source
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	1 # -- coding: utf-8 --
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	2 #
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	3 # Boomslang documentation build configuration file, created by
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	4 # sphinx-quickstart on Mon Aug 23 00:49:49 2010.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	5 #
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	6 # This file is execfile()d with the current directory set to its containing
d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	7 # dir.
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	8 #
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	9 # Note that not all possible configuration values are present in this
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	10 # autogenerated file.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	11 #
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	12 # All configuration values have a default; values that are commented out
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	13 # serve to show the default.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	14
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	15 # If extensions (or modules to document with autodoc) are in another directory,
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	16 # add these directories to sys.path here. If the directory is relative to the
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	17 # documentation root, use os.path.abspath to make it absolute, like shown here.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	18 #sys.path.insert(0, os.path.abspath('.'))
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	19
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	20 # -- General configuration ----------------------------------------------------
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	21
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	22 # If your documentation needs a minimal Sphinx version, state it here.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	23 #needs_sphinx = '1.0'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	24
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	25 # Add any Sphinx extension module names here, as strings. They can be
d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	26 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	27 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	28
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	29 # Add any paths that contain templates here, relative to this directory.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	30 templates_path = ['_templates']
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	31
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	32 # The suffix of source filenames.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	33 source_suffix = '.rst'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	34
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	35 # The encoding of source files.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	36 #source_encoding = 'utf-8-sig'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	37
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	38 # The master toctree document.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	39 master_doc = 'index'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	40
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	41 # General information about the project.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	42 project = u'Boomslang'
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	43 copyright = u'2010, Simon Cross, Adrianna Pinska, Jeremy Thurgood,' \
d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	44 ' Neil Muller, Stefano Rivera'
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	45
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	46 # The version info for the project you're documenting, acts as replacement for
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	47 # \|version\| and \|release\|, also used in various other places throughout the
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	48 # built documents.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	49 #
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	50 # The short X.Y version.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	51 version = '0.1'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	52 # The full version, including alpha/beta/rc tags.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	53 release = '0.1'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	54
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	55 # The language for content autogenerated by Sphinx. Refer to documentation
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	56 # for a list of supported languages.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	57 #language = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	58
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	59 # There are two options for replacing \|today\|: either, you set today to some
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	60 # non-false value, then it is used:
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	61 #today = ''
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	62 # Else, today_fmt is used as the format for a strftime call.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	63 #today_fmt = '%B %d, %Y'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	64
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	65 # List of patterns, relative to source directory, that match files and
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	66 # directories to ignore when looking for source files.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	67 exclude_patterns = ['_build']
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	68
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	69 # The reST default role (used for this markup: `text`) to use for all
d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	70 # documents.
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	71 #default_role = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	72
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	73 # If true, '()' will be appended to :func: etc. cross-reference text.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	74 #add_function_parentheses = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	75
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	76 # If true, the current module name will be prepended to all description
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	77 # unit titles (such as .. function::).
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	78 #add_module_names = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	79
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	80 # If true, sectionauthor and moduleauthor directives will be shown in the
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	81 # output. They are ignored by default.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	82 #show_authors = False
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	83
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	84 # The name of the Pygments (syntax highlighting) style to use.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	85 pygments_style = 'sphinx'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	86
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	87 # A list of ignored prefixes for module index sorting.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	88 #modindex_common_prefix = []
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	89
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	90 # -- Options for HTML output --------------------------------------------------
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	91
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	92 # The theme to use for HTML and HTML Help pages. See the documentation for
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	93 # a list of builtin themes.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	94 html_theme = 'default'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	95
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	96 # Theme options are theme-specific and customize the look and feel of a theme
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	97 # further. For a list of options available for each theme, see the
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	98 # documentation.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	99 #html_theme_options = {}
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	100
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	101 # Add any paths that contain custom themes here, relative to this directory.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	102 #html_theme_path = []
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	103
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	104 # The name for this set of Sphinx documents. If None, it defaults to
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	105 # "<project> v<release> documentation".
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	106 #html_title = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	107
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	108 # A shorter title for the navigation bar. Default is the same as html_title.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	109 #html_short_title = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	110
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	111 # The name of an image file (relative to this directory) to place at the top
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	112 # of the sidebar.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	113 #html_logo = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	114
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	115 # The name of an image file (within the static path) to use as favicon of the
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	117 # pixels large.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	118 #html_favicon = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	119
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	120 # Add any paths that contain custom static files (such as style sheets) here,
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	121 # relative to this directory. They are copied after the builtin static files,
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	122 # so a file named "default.css" will overwrite the builtin "default.css".
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	123 html_static_path = ['_static']
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	124
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	126 # using the given strftime format.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	127 #html_last_updated_fmt = '%b %d, %Y'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	128
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	129 # If true, SmartyPants will be used to convert quotes and dashes to
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	130 # typographically correct entities.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	131 #html_use_smartypants = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	132
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	133 # Custom sidebar templates, maps document names to template names.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	134 #html_sidebars = {}
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	135
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	136 # Additional templates that should be rendered to pages, maps page names to
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	137 # template names.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	138 #html_additional_pages = {}
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	139
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	140 # If false, no module index is generated.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	141 #html_domain_indices = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	142
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	143 # If false, no index is generated.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	144 #html_use_index = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	145
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	146 # If true, the index is split into individual pages for each letter.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	147 #html_split_index = False
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	148
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	149 # If true, links to the reST sources are added to the pages.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	150 #html_show_sourcelink = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	151
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	152 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	153 #html_show_sphinx = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	154
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	155 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	156 #html_show_copyright = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	157
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	158 # If true, an OpenSearch description file will be output, and all pages will
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	159 # contain a <link> tag referring to it. The value of this option must be the
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	160 # base URL from which the finished HTML is served.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	161 #html_use_opensearch = ''
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	162
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	163 # This is the file name suffix for HTML files (e.g. ".xhtml").
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	164 #html_file_suffix = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	165
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	166 # Output file base name for HTML help builder.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	167 htmlhelp_basename = 'Boomslangdoc'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	168
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	169
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	170 # -- Options for LaTeX output -------------------------------------------------
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	171
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	172 # The paper size ('letter' or 'a4').
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	173 #latex_paper_size = 'letter'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	174
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	175 # The font size ('10pt', '11pt' or '12pt').
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	176 #latex_font_size = '10pt'
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	177
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	178 # Grouping the document tree into LaTeX files. List of tuples
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	179 # (source start file, target name, title, author, documentclass
d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	180 # [howto/manual]).
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	181 latex_documents = [
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	182 ('index', 'Boomslang.tex', u'Boomslang Documentation',
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	183 u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller,'
d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	184 ' Stefano Rivera', 'manual'),
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	185 ]
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	186
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	187 # The name of an image file (relative to this directory) to place at the top of
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	188 # the title page.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	189 #latex_logo = None
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	190
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	191 # For "manual" documents, if this is true, then toplevel headings are parts,
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	192 # not chapters.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	193 #latex_use_parts = False
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	194
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	195 # If true, show page references after internal links.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	196 #latex_show_pagerefs = False
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	197
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	198 # If true, show URL addresses after external links.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	199 #latex_show_urls = False
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	200
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	201 # Additional stuff for the LaTeX preamble.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	202 #latex_preamble = ''
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	203
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	204 # Documents to append as an appendix to all manuals.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	205 #latex_appendices = []
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	206
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	207 # If false, no module index is generated.
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	208 #latex_domain_indices = True
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	209
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	210
538 d1b86d5849a0 More pep8 cleanups Neil Muller <neil@dip.sun.ac.za> parents: 42 diff changeset	211 # -- Options for manual page output -------------------------------------------
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	212
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	213 # One entry per manual page. List of tuples
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	214 # (source start file, name, description, authors, manual section).
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	215 man_pages = [
3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	216 ('index', 'boomslang', u'Boomslang Documentation',
545 0740f6a537ea pyflakes cleanup Neil Muller <neil@dip.sun.ac.za> parents: 538 diff changeset	217 [u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller,'
0740f6a537ea pyflakes cleanup Neil Muller <neil@dip.sun.ac.za> parents: 538 diff changeset	218 ' Stefano Rivera'], 1)
42 3794e7f4093e Add sphinx-based documentation (for walkthrough, artist help, etc). Simon Cross <hodgestar+bzr@gmail.com> parents: diff changeset	219 ]

Mercurial > boomslang

annotate docs/conf.py @ 854:79b5c1be9a5e default tip