Mercurial > pyntnclick
annotate docs/conf.py @ 538:d1b86d5849a0
More pep8 cleanups
author | Neil Muller <neil@dip.sun.ac.za> |
---|---|
date | Sat, 11 Feb 2012 12:15:31 +0200 |
parents | 3794e7f4093e |
children | 0740f6a537ea |
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 | 6 # This file is execfile()d with the current directory set to its containing |
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 |
538 | 15 import sys |
16 import os | |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
17 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
18 # 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
|
19 # 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
|
20 # 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
|
21 #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
|
22 |
538 | 23 # -- General configuration ---------------------------------------------------- |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
24 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
25 # 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
|
26 #needs_sphinx = '1.0' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
27 |
538 | 28 # Add any Sphinx extension module names here, as strings. They can be |
29 # 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
|
30 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
|
31 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
32 # 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
|
33 templates_path = ['_templates'] |
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 suffix of source filenames. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
36 source_suffix = '.rst' |
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 encoding of source files. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
39 #source_encoding = 'utf-8-sig' |
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 # The master toctree document. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
42 master_doc = 'index' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
43 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
44 # General information about the project. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
45 project = u'Boomslang' |
538 | 46 copyright = u'2010, Simon Cross, Adrianna Pinska, Jeremy Thurgood,' \ |
47 ' Neil Muller, Stefano Rivera' | |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
48 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
49 # 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
|
50 # |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
|
51 # built documents. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
52 # |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
53 # The short X.Y version. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
54 version = '0.1' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
55 # 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
|
56 release = '0.1' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
57 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
58 # 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
|
59 # 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
|
60 #language = None |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
61 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
62 # 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
|
63 # 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
|
64 #today = '' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
65 # 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
|
66 #today_fmt = '%B %d, %Y' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
67 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
68 # 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
|
69 # 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
|
70 exclude_patterns = ['_build'] |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
71 |
538 | 72 # The reST default role (used for this markup: `text`) to use for all |
73 # documents. | |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
74 #default_role = None |
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, '()' 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
|
77 #add_function_parentheses = True |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
78 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
79 # 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
|
80 # unit titles (such as .. function::). |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
81 #add_module_names = True |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
82 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
83 # 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
|
84 # 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
|
85 #show_authors = False |
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 # 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
|
88 pygments_style = 'sphinx' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
89 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
90 # 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
|
91 #modindex_common_prefix = [] |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
92 |
538 | 93 # -- Options for HTML output -------------------------------------------------- |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
94 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
95 # 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
|
96 # a list of builtin themes. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
97 html_theme = 'default' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
98 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
99 # 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
|
100 # 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
|
101 # documentation. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
102 #html_theme_options = {} |
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 # 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
|
105 #html_theme_path = [] |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
106 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
107 # 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
|
108 # "<project> v<release> documentation". |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
109 #html_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 # 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
|
112 #html_short_title = None |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
113 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
114 # 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
|
115 # of the sidebar. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
116 #html_logo = None |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
117 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
118 # 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
|
119 # 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
|
120 # pixels large. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
121 #html_favicon = None |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
122 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
123 # 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
|
124 # 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
|
125 # 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
|
126 html_static_path = ['_static'] |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
127 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
128 # 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
|
129 # using the given strftime format. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
130 #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
|
131 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
132 # 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
|
133 # typographically correct entities. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
134 #html_use_smartypants = True |
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 # 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
|
137 #html_sidebars = {} |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
138 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
139 # 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
|
140 # template names. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
141 #html_additional_pages = {} |
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 module index is generated. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
144 #html_domain_indices = 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 false, no index is generated. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
147 #html_use_index = True |
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, 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
|
150 #html_split_index = False |
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, 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
|
153 #html_show_sourcelink = 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, "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
|
156 #html_show_sphinx = 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, "(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
|
159 #html_show_copyright = True |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
160 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
161 # 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
|
162 # 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
|
163 # 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
|
164 #html_use_opensearch = '' |
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 # 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
|
167 #html_file_suffix = None |
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 # 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
|
170 htmlhelp_basename = 'Boomslangdoc' |
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 |
538 | 173 # -- Options for LaTeX output ------------------------------------------------- |
42
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 paper size ('letter' or 'a4'). |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
176 #latex_paper_size = 'letter' |
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 # 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
|
179 #latex_font_size = '10pt' |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
180 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
181 # Grouping the document tree into LaTeX files. List of tuples |
538 | 182 # (source start file, target name, title, author, documentclass |
183 # [howto/manual]). | |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
184 latex_documents = [ |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
185 ('index', 'Boomslang.tex', u'Boomslang Documentation', |
538 | 186 u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller,' |
187 ' Stefano Rivera', 'manual'), | |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
188 ] |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
189 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
190 # 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
|
191 # the title page. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
192 #latex_logo = None |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
193 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
194 # 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
|
195 # not chapters. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
196 #latex_use_parts = 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 page references after internal links. |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
199 #latex_show_pagerefs = 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 # 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
|
202 #latex_show_urls = False |
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 # 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
|
205 #latex_preamble = '' |
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 # 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
|
208 #latex_appendices = [] |
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 # 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
|
211 #latex_domain_indices = True |
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 |
538 | 214 # -- 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
|
215 |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
216 # 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
|
217 # (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
|
218 man_pages = [ |
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
219 ('index', 'boomslang', u'Boomslang Documentation', |
538 | 220 [u'Simon Cross, Adrianna Pinska, Jeremy Thurgood, Neil Muller,'' |
221 Stefano Rivera'], 1) | |
42
3794e7f4093e
Add sphinx-based documentation (for walkthrough, artist help, etc).
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff
changeset
|
222 ] |