Debian Codegraph @

docs/conf.py

raw
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3 #
4 # aiohttp_sse_client2 documentation build configuration file, created by
5 # sphinx-quickstart on Fri Jun 9 13:47:02 2017.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
16 # If extensions (or modules to document with autodoc) are in another
17 # directory, add these directories to sys.path here. If the directory is
18 # relative to the documentation root, use os.path.abspath to make it
19 # absolute, like shown here.
20 #
21 import os
22 import sys
23 sys.path.insert(0, os.path.abspath('..'))
24
25 import aiohttp_sse_client2
26
27 # -- General configuration ---------------------------------------------
28
29 # If your documentation needs a minimal Sphinx version, state it here.
30 #
31 # needs_sphinx = '1.0'
32
33 # Add any Sphinx extension module names here, as strings. They can be
34 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
36
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
39
40 # The suffix(es) of source filenames.
41 # You can specify multiple suffix as a list of string:
42 #
43 # source_suffix = ['.rst', '.md']
44 source_suffix = '.rst'
45
46 # The master toctree document.
47 master_doc = 'index'
48
49 # General information about the project.
50 project = u'SSE Client'
51 copyright = u"2018-2020, Jason Hu"
52 author = u"Jason Hu"
53
54 # The version info for the project you're documenting, acts as replacement
55 # for |version| and |release|, also used in various other places throughout
56 # the built documents.
57 #
58 # The short X.Y version.
59 version = aiohttp_sse_client2.__version__
60 # The full version, including alpha/beta/rc tags.
61 release = aiohttp_sse_client2.__version__
62
63 # The language for content autogenerated by Sphinx. Refer to documentation
64 # for a list of supported languages.
65 #
66 # This is also used if you do content translation via gettext catalogs.
67 # Usually you set "language" from the command line for these cases.
68 language = None
69
70 # List of patterns, relative to source directory, that match files and
71 # directories to ignore when looking for source files.
72 # This patterns also effect to html_static_path and html_extra_path
73 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
74
75 # The name of the Pygments (syntax highlighting) style to use.
76 pygments_style = 'sphinx'
77
78 # If true, `todo` and `todoList` produce output, else they produce nothing.
79 todo_include_todos = False
80
81
82 # -- Options for HTML output -------------------------------------------
83
84 # The theme to use for HTML and HTML Help pages. See the documentation for
85 # a list of builtin themes.
86 #
87 html_theme = 'alabaster'
88
89 # Theme options are theme-specific and customize the look and feel of a
90 # theme further. For a list of options available for each theme, see the
91 # documentation.
92 #
93 # html_theme_options = {}
94
95 # Add any paths that contain custom static files (such as style sheets) here,
96 # relative to this directory. They are copied after the builtin static files,
97 # so a file named "default.css" will overwrite the builtin "default.css".
98 html_static_path = ['_static']
99
100
101 # -- Options for HTMLHelp output ---------------------------------------
102
103 # Output file base name for HTML help builder.
104 htmlhelp_basename = 'aiohttp_sse_clientdoc'
105
106
107 # -- Options for LaTeX output ------------------------------------------
108
109 latex_elements = {
110 # The paper size ('letterpaper' or 'a4paper').
111 #
112 # 'papersize': 'letterpaper',
113
114 # The font size ('10pt', '11pt' or '12pt').
115 #
116 # 'pointsize': '10pt',
117
118 # Additional stuff for the LaTeX preamble.
119 #
120 # 'preamble': '',
121
122 # Latex figure (float) alignment
123 #
124 # 'figure_align': 'htbp',
125 }
126
127 # Grouping the document tree into LaTeX files. List of tuples
128 # (source start file, target name, title, author, documentclass
129 # [howto, manual, or own class]).
130 latex_documents = [
131 (master_doc, 'aiohttp_sse_client2.tex',
132 u'SSE Client Documentation',
133 u'Jason Hu', 'manual'),
134 ]
135
136
137 # -- Options for manual page output ------------------------------------
138
139 # One entry per manual page. List of tuples
140 # (source start file, name, description, authors, manual section).
141 man_pages = [
142 (master_doc, 'aiohttp_sse_client2',
143 u'SSE Client Documentation',
144 [author], 1)
145 ]
146
147
148 # -- Options for Texinfo output ----------------------------------------
149
150 # Grouping the document tree into Texinfo files. List of tuples
151 # (source start file, target name, title, author,
152 # dir menu entry, description, category)
153 texinfo_documents = [
154 (master_doc, 'aiohttp_sse_client2',
155 u'SSE Client Documentation',
156 author,
157 'aiohttp_sse_client2',
158 'A Server-Sent Event python client base on aiohttp, provides a simple interface to process Server-Sent Event.',
159 'Miscellaneous'),
160 ]
161
162
163