1
# -*- coding: utf-8 -*-
3
# ryu documentation build configuration file, created by
4
# sphinx-quickstart on Mon Dec 5 15:38:48 2011.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
16
# If extensions (or modules to document with autodoc) are in another directory,
17
# add these directories to sys.path here. If the directory is relative to the
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
sys.path.insert(0, os.path.abspath('../..'))
20
sys.path.insert(0, os.path.abspath('.'))
22
from ryu import version as ryu_version
24
# -- General configuration -----------------------------------------------------
26
# If your documentation needs a minimal Sphinx version, state it here.
29
# Add any Sphinx extension module names here, as strings. They can be extensions
30
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31
extensions = [ 'sphinx.ext.autodoc' ]
33
# Add any paths that contain templates here, relative to this directory.
34
templates_path = ['_templates']
36
# The suffix of source filenames.
37
source_suffix = '.rst'
39
# The encoding of source files.
40
#source_encoding = 'utf-8-sig'
42
# The master toctree document.
45
# General information about the project.
47
copyright = u'2011-2014 Nippon Telegraph and Telephone Corporation'
49
# The version info for the project you're documenting, acts as replacement for
50
# |version| and |release|, also used in various other places throughout the
53
# The short X.Y version.
55
# The full version, including alpha/beta/rc tags.
58
# The language for content autogenerated by Sphinx. Refer to documentation
59
# for a list of supported languages.
62
# There are two options for replacing |today|: either, you set today to some
63
# non-false value, then it is used:
65
# Else, today_fmt is used as the format for a strftime call.
66
#today_fmt = '%B %d, %Y'
68
# List of patterns, relative to source directory, that match files and
69
# directories to ignore when looking for source files.
72
# The reST default role (used for this markup: `text`) to use for all documents.
75
# If true, '()' will be appended to :func: etc. cross-reference text.
76
#add_function_parentheses = True
78
# If true, the current module name will be prepended to all description
79
# unit titles (such as .. function::).
80
#add_module_names = True
82
# If true, sectionauthor and moduleauthor directives will be shown in the
83
# output. They are ignored by default.
86
# The name of the Pygments (syntax highlighting) style to use.
87
pygments_style = 'sphinx'
89
# A list of ignored prefixes for module index sorting.
90
#modindex_common_prefix = []
93
# -- Options for HTML output ---------------------------------------------------
95
# The theme to use for HTML and HTML Help pages. See the documentation for
96
# a list of builtin themes.
99
# Theme options are theme-specific and customize the look and feel of a theme
100
# further. For a list of options available for each theme, see the
102
#html_theme_options = {}
104
# Add any paths that contain custom themes here, relative to this directory.
105
#html_theme_path = []
107
# The name for this set of Sphinx documents. If None, it defaults to
108
# "<project> v<release> documentation".
111
# A shorter title for the navigation bar. Default is the same as html_title.
112
#html_short_title = None
114
# The name of an image file (relative to this directory) to place at the top
118
# The name of an image file (within the static path) to use as favicon of the
119
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123
# Add any paths that contain custom static files (such as style sheets) here,
124
# relative to this directory. They are copied after the builtin static files,
125
# so a file named "default.css" will overwrite the builtin "default.css".
126
html_static_path = ['_static']
128
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129
# using the given strftime format.
130
#html_last_updated_fmt = '%b %d, %Y'
132
# If true, SmartyPants will be used to convert quotes and dashes to
133
# typographically correct entities.
134
#html_use_smartypants = True
136
# Custom sidebar templates, maps document names to template names.
139
# Additional templates that should be rendered to pages, maps page names to
141
#html_additional_pages = {}
143
# If false, no module index is generated.
144
#html_domain_indices = True
146
# If false, no index is generated.
147
#html_use_index = True
149
# If true, the index is split into individual pages for each letter.
150
#html_split_index = False
152
# If true, links to the reST sources are added to the pages.
153
#html_show_sourcelink = True
155
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156
#html_show_sphinx = True
158
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159
#html_show_copyright = True
161
# If true, an OpenSearch description file will be output, and all pages will
162
# contain a <link> tag referring to it. The value of this option must be the
163
# base URL from which the finished HTML is served.
164
#html_use_opensearch = ''
166
# This is the file name suffix for HTML files (e.g. ".xhtml").
167
#html_file_suffix = None
169
# Output file base name for HTML help builder.
170
htmlhelp_basename = 'ryudoc'
173
# -- Options for LaTeX output --------------------------------------------------
175
# The paper size ('letter' or 'a4').
176
#latex_paper_size = 'letter'
178
# The font size ('10pt', '11pt' or '12pt').
179
#latex_font_size = '10pt'
181
# Grouping the document tree into LaTeX files. List of tuples
182
# (source start file, target name, title, author, documentclass [howto/manual]).
184
('index', 'ryu.tex', u'ryu Documentation',
185
u'ryu development team', 'manual'),
188
# The name of an image file (relative to this directory) to place at the top of
192
# For "manual" documents, if this is true, then toplevel headings are parts,
194
#latex_use_parts = False
196
# If true, show page references after internal links.
197
#latex_show_pagerefs = False
199
# If true, show URL addresses after external links.
200
#latex_show_urls = False
202
# Additional stuff for the LaTeX preamble.
205
# Documents to append as an appendix to all manuals.
206
#latex_appendices = []
208
# If false, no module index is generated.
209
#latex_domain_indices = True
212
# -- Options for manual page output --------------------------------------------
214
# One entry per manual page. List of tuples
215
# (source start file, name, description, authors, manual section).
217
('index', 'ryu', u'ryu Documentation',
218
[u'Ryu development team'], 8),
219
('man/ryu', 'ryu', u'management for Ryu application',
220
[u'Ryu development team'], 8),
221
('man/ryu_manager', 'ryu-manager', 'management for Ryu application',
222
[u'Ryu development team'], 8),
added
removed
doc/source/conf.py
