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