Debian Codegraph @

pbr/tests/testpackage/doc/source/conf.py

raw
1 # -*- coding: utf-8 -*-
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at
5 #
6 # http://www.apache.org/licenses/LICENSE-2.0
7 #
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11 # implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15
16 # -- General configuration ----------------------------------------------------
17
18 # Add any Sphinx extension module names here, as strings. They can be
19 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
20 extensions = [
21 'sphinx.ext.autodoc',
22 ]
23
24 # autodoc generation is a bit aggressive and a nuisance when doing heavy
25 # text edit cycles.
26 # execute "export SPHINX_DEBUG=1" in your terminal to disable
27
28 # The suffix of source filenames.
29 source_suffix = '.rst'
30
31 # The master toctree document.
32 master_doc = 'index'
33
34 # General information about the project.
35 project = u'testpackage'
36 copyright = u'2013, OpenStack Foundation'
37
38 # If true, '()' will be appended to :func: etc. cross-reference text.
39 add_function_parentheses = True
40
41 # If true, the current module name will be prepended to all description
42 # unit titles (such as .. function::).
43 add_module_names = True
44
45 # The name of the Pygments (syntax highlighting) style to use.
46 pygments_style = 'sphinx'
47
48
49 # -- Options for HTML output --------------------------------------------------
50
51 # Grouping the document tree into LaTeX files. List of tuples
52 # (source start file, target name, title, author, documentclass
53 # [howto/manual]).
54 latex_documents = [
55 (
56 'index',
57 '%s.tex' % project,
58 u'%s Documentation' % project,
59 u'OpenStack Foundation',
60 'manual',
61 ),
62 ]