1 # -*- coding: utf-8 -*-
2 # nghttp2 - HTTP/2 C Library
4 # Copyright (c) 2012 Tatsuhiro Tsujikawa
6 # Permission is hereby granted, free of charge, to any person obtaining
7 # a copy of this software and associated documentation files (the
8 # "Software"), to deal in the Software without restriction, including
9 # without limitation the rights to use, copy, modify, merge, publish,
10 # distribute, sublicense, and/or sell copies of the Software, and to
11 # permit persons to whom the Software is furnished to do so, subject to
12 # the following conditions:
14 # The above copyright notice and this permission notice shall be
15 # included in all copies or substantial portions of the Software.
17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 # nghttp2 documentation build configuration file, created by
27 # sphinx-quickstart on Sun Mar 11 22:57:49 2012.
29 # This file is execfile()d with the current directory set to its containing dir.
31 # Note that not all possible configuration values are present in this
34 # All configuration values have a default; values that are commented out
35 # serve to show the default.
39 # If extensions (or modules to document with autodoc) are in another directory,
40 # add these directories to sys.path here. If the directory is relative to the
41 # documentation root, use os.path.abspath to make it absolute, like shown here.
42 #sys.path.insert(0, os.path.abspath('.'))
44 sys.path.append(os.path.abspath('@top_srcdir@/doc/_exts'))
46 # -- General configuration -----------------------------------------------------
48 # If your documentation needs a minimal Sphinx version, state it here.
51 # Add any Sphinx extension module names here, as strings. They can be extensions
52 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
53 extensions = ['sphinxcontrib.rubydomain']
55 # Add any paths that contain templates here, relative to this directory.
56 templates_path = ['@top_srcdir@/_templates']
58 # The suffix of source filenames.
59 source_suffix = '.rst'
61 # The encoding of source files.
62 #source_encoding = 'utf-8-sig'
64 # The master toctree document.
67 # General information about the project.
69 copyright = u'2012, 2015, 2016, Tatsuhiro Tsujikawa'
71 # The version info for the project you're documenting, acts as replacement for
72 # |version| and |release|, also used in various other places throughout the
75 # The short X.Y version.
76 version = '@PACKAGE_VERSION@'
77 # The full version, including alpha/beta/rc tags.
78 release = '@PACKAGE_VERSION@'
80 # The language for content autogenerated by Sphinx. Refer to documentation
81 # for a list of supported languages.
84 # There are two options for replacing |today|: either, you set today to some
85 # non-false value, then it is used:
87 # Else, today_fmt is used as the format for a strftime call.
88 #today_fmt = '%B %d, %Y'
90 # List of patterns, relative to source directory, that match files and
91 # directories to ignore when looking for source files.
92 exclude_patterns = ['manual', 'README.rst', '*-header.rst', 'sources']
94 # The reST default role (used for this markup: `text`) to use for all documents.
95 default_role = 'c:func'
98 # If true, '()' will be appended to :func: etc. cross-reference text.
99 #add_function_parentheses = True
101 # If true, the current module name will be prepended to all description
102 # unit titles (such as .. function::).
103 #add_module_names = True
105 # If true, sectionauthor and moduleauthor directives will be shown in the
106 # output. They are ignored by default.
107 #show_authors = False
109 # The default language to highlight source code in. The default is 'python'.
110 highlight_language = 'c'
112 # The name of the Pygments (syntax highlighting) style to use.
113 pygments_style = 'sphinx'
115 # A list of ignored prefixes for module index sorting.
116 #modindex_common_prefix = []
119 # -- Options for HTML output ---------------------------------------------------
121 # The theme to use for HTML and HTML Help pages. See the documentation for
122 # a list of builtin themes.
123 html_theme = 'sphinx_rtd_theme'
125 # Theme options are theme-specific and customize the look and feel of a theme
126 # further. For a list of options available for each theme, see the
128 #html_theme_options = {}
130 # Add any paths that contain custom themes here, relative to this directory.
131 html_theme_path = ['@top_srcdir@/doc/_themes']
133 # The name for this set of Sphinx documents. If None, it defaults to
134 # "<project> v<release> documentation".
137 # A shorter title for the navigation bar. Default is the same as html_title.
138 #html_short_title = None
140 # The name of an image file (relative to this directory) to place at the top
144 # The name of an image file (within the static path) to use as favicon of the
145 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
149 # Add any paths that contain custom static files (such as style sheets) here,
150 # relative to this directory. They are copied after the builtin static files,
151 # so a file named "default.css" will overwrite the builtin "default.css".
152 #html_static_path = []
154 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
155 # using the given strftime format.
156 #html_last_updated_fmt = '%b %d, %Y'
158 # If true, SmartyPants will be used to convert quotes and dashes to
159 # typographically correct entities.
160 #html_use_smartypants = False
162 # Custom sidebar templates, maps document names to template names.
164 '**': ['menu.html', 'localtoc.html', 'relations.html', 'sourcelink.html',
168 # Additional templates that should be rendered to pages, maps page names to
170 #html_additional_pages = {}
172 # If false, no module index is generated.
173 #html_domain_indices = True
175 # If false, no index is generated.
176 #html_use_index = True
178 # If true, the index is split into individual pages for each letter.
179 #html_split_index = False
181 # If true, links to the reST sources are added to the pages.
182 html_show_sourcelink = False
183 html_copy_source = False
185 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
186 #html_show_sphinx = True
188 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
189 #html_show_copyright = True
191 # If true, an OpenSearch description file will be output, and all pages will
192 # contain a <link> tag referring to it. The value of this option must be the
193 # base URL from which the finished HTML is served.
194 #html_use_opensearch = ''
196 # This is the file name suffix for HTML files (e.g. ".xhtml").
197 #html_file_suffix = None
199 # Output file base name for HTML help builder.
200 htmlhelp_basename = 'nghttp2doc'
203 # -- Options for LaTeX output --------------------------------------------------
205 # The paper size ('letter' or 'a4').
206 #latex_paper_size = 'letter'
208 # The font size ('10pt', '11pt' or '12pt').
209 #latex_font_size = '10pt'
211 # Grouping the document tree into LaTeX files. List of tuples
212 # (source start file, target name, title, author, documentclass [howto/manual]).
214 ('index', 'nghttp2.tex', u'nghttp2 Documentation',
215 u'Tatsuhiro Tsujikawa', 'manual'),
218 # The name of an image file (relative to this directory) to place at the top of
222 # For "manual" documents, if this is true, then toplevel headings are parts,
224 #latex_use_parts = False
226 # If true, show page references after internal links.
227 #latex_show_pagerefs = False
229 # If true, show URL addresses after external links.
230 #latex_show_urls = False
232 # Additional stuff for the LaTeX preamble.
235 # Documents to append as an appendix to all manuals.
236 #latex_appendices = []
238 # If false, no module index is generated.
239 #latex_domain_indices = True
242 # -- Options for manual page output --------------------------------------------
244 # One entry per manual page. List of tuples
245 # (source start file, name, description, authors, manual section).
247 ('nghttp.1', 'nghttp', u'HTTP/2 client', [u'Tatsuhiro Tsujikawa'], 1),
248 ('nghttpd.1', 'nghttpd', u'HTTP/2 server', [u'Tatsuhiro Tsujikawa'], 1),
249 ('nghttpx.1', 'nghttpx', u'HTTP/2 proxy', [u'Tatsuhiro Tsujikawa'], 1),
250 ('h2load.1', 'h2load', u'HTTP/2 benchmarking tool',
251 [u'Tatsuhiro Tsujikawa'], 1)