Debian Codegraph @

doc/source/conf.py.in

raw
1 # nghttp3
2
3 # Copyright (c) 2020 nghttp3 contributors
4
5 # Permission is hereby granted, free of charge, to any person obtaining
6 # a copy of this software and associated documentation files (the
7 # "Software"), to deal in the Software without restriction, including
8 # without limitation the rights to use, copy, modify, merge, publish,
9 # distribute, sublicense, and/or sell copies of the Software, and to
10 # permit persons to whom the Software is furnished to do so, subject to
11 # the following conditions:
12
13 # The above copyright notice and this permission notice shall be
14 # included in all copies or substantial portions of the Software.
15
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
24 # Configuration file for the Sphinx documentation builder.
25 #
26 # This file only contains a selection of the most common options. For a full
27 # list see the documentation:
28 # https://www.sphinx-doc.org/en/master/usage/configuration.html
29
30 # -- Path setup --------------------------------------------------------------
31
32 # If extensions (or modules to document with autodoc) are in another directory,
33 # add these directories to sys.path here. If the directory is relative to the
34 # documentation root, use os.path.abspath to make it absolute, like shown here.
35 #
36 # import os
37 # import sys
38 # sys.path.insert(0, os.path.abspath('.'))
39
40
41 # -- Project information -----------------------------------------------------
42
43 project = 'nghttp3'
44 copyright = '2020, nghttp3 contributors'
45 author = 'nghttp3 contributors'
46
47
48 # -- General configuration ---------------------------------------------------
49
50 # Add any Sphinx extension module names here, as strings. They can be
51 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
52 # ones.
53 extensions = [
54 ]
55
56 # Add any paths that contain templates here, relative to this directory.
57 templates_path = ['_templates']
58
59 # List of patterns, relative to source directory, that match files and
60 # directories to ignore when looking for source files.
61 # This pattern also affects html_static_path and html_extra_path.
62 exclude_patterns = []
63
64
65 # -- Options for HTML output -------------------------------------------------
66
67 # The theme to use for HTML and HTML Help pages. See the documentation for
68 # a list of builtin themes.
69 #
70 html_theme = 'sphinx_rtd_theme'
71
72 # Add any paths that contain custom static files (such as style sheets) here,
73 # relative to this directory. They are copied after the builtin static files,
74 # so a file named "default.css" will overwrite the builtin "default.css".
75 html_static_path = ['_static']
76
77 # The reST default role (used for this markup: `text`) to use for all documents.
78 default_role = 'c:func'
79 primary_domain = 'c'
80
81 # manpage URL pattern
82 manpages_url = 'https://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
83
84 # The default language to highlight source code in.
85 highlight_language = 'c'
86
87 # The version info for the project you're documenting, acts as replacement for
88 # |version| and |release|, also used in various other places throughout the
89 # built documents.
90 #
91 # The short X.Y version.
92 version = '@PACKAGE_VERSION@'
93 # The full version, including alpha/beta/rc tags.
94 release = '@PACKAGE_VERSION@'