1# -*- coding: utf-8 -*-
2#
3# Configuration file for the Sphinx documentation builder.
4#
5# This file does only contain a selection of the most common options. For a
6# full list see the documentation:
7# http://www.sphinx-doc.org/en/master/config
8
9# -- Path setup --------------------------------------------------------------
10
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
14#
15# import os
16# import sys
17# sys.path.insert(0, os.path.abspath('.'))
18
19
20# -- Project information -----------------------------------------------------
21
22project = u'lsquic'
23copyright = u'2022, LiteSpeed Technologies'
24author = u'LiteSpeed Technologies'
25
26# The short X.Y version
27version = u'3.1'
28# The full version, including alpha/beta/rc tags
29release = u'3.1.1'
30
31
32# -- General configuration ---------------------------------------------------
33
34# If your documentation needs a minimal Sphinx version, state it here.
35#
36# needs_sphinx = '1.0'
37
38# Add any Sphinx extension module names here, as strings. They can be
39# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40# ones.
41extensions = [
42# To make ours look like readthedocs.io, change theme to "sphinx_rtd_theme",
43# pip install sphinx_rtd_theme, and uncomment extensions:
44#    "sphinx.ext.intersphinx",
45#    "sphinx.ext.autodoc",
46#    "sphinx.ext.mathjax",
47#    "sphinx.ext.viewcode",
48]
49
50# Add any paths that contain templates here, relative to this directory.
51templates_path = ['_templates']
52
53# The suffix(es) of source filenames.
54# You can specify multiple suffix as a list of string:
55#
56# source_suffix = ['.rst', '.md']
57source_suffix = '.rst'
58
59# The master toctree document.
60master_doc = 'index'
61
62# The language for content autogenerated by Sphinx. Refer to documentation
63# for a list of supported languages.
64#
65# This is also used if you do content translation via gettext catalogs.
66# Usually you set "language" from the command line for these cases.
67language = None
68
69# List of patterns, relative to source directory, that match files and
70# directories to ignore when looking for source files.
71# This pattern also affects html_static_path and html_extra_path.
72exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
73
74# The name of the Pygments (syntax highlighting) style to use.
75pygments_style = None
76
77default_role = 'c:func'
78primary_domain = 'c'
79
80
81# -- Options for HTML output -------------------------------------------------
82
83# The theme to use for HTML and HTML Help pages.  See the documentation for
84# a list of builtin themes.
85#
86#html_theme = 'alabaster'
87html_style = '/default.css'
88
89# Theme options are theme-specific and customize the look and feel of a theme
90# 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".
98html_static_path = ['_static']
99
100# Custom sidebar templates, must be a dictionary that maps document names
101# to template names.
102#
103# The default sidebars (for documents that don't match any pattern) are
104# defined by theme itself.  Builtin themes are using these templates by
105# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
106# 'searchbox.html']``.
107#
108# html_sidebars = {}
109
110
111# -- Options for HTMLHelp output ---------------------------------------------
112
113# Output file base name for HTML help builder.
114htmlhelp_basename = 'lsquicdoc'
115
116
117# -- Options for LaTeX output ------------------------------------------------
118
119latex_elements = {
120    # The paper size ('letterpaper' or 'a4paper').
121    #
122    # 'papersize': 'letterpaper',
123
124    # The font size ('10pt', '11pt' or '12pt').
125    #
126    # 'pointsize': '10pt',
127
128    # Additional stuff for the LaTeX preamble.
129    #
130    # 'preamble': '',
131
132    # Latex figure (float) alignment
133    #
134    # 'figure_align': 'htbp',
135}
136
137# Grouping the document tree into LaTeX files. List of tuples
138# (source start file, target name, title,
139#  author, documentclass [howto, manual, or own class]).
140latex_documents = [
141    (master_doc, 'lsquic.tex', u'lsquic Documentation',
142     u'LiteSpeed Technologies', 'manual'),
143]
144
145
146# -- Options for manual page output ------------------------------------------
147
148# One entry per manual page. List of tuples
149# (source start file, name, description, authors, manual section).
150man_pages = [
151    (master_doc, 'lsquic', u'lsquic Documentation',
152     [author], 1)
153]
154
155
156# -- Options for Texinfo output ----------------------------------------------
157
158# Grouping the document tree into Texinfo files. List of tuples
159# (source start file, target name, title, author,
160#  dir menu entry, description, category)
161texinfo_documents = [
162    (master_doc, 'lsquic', u'lsquic Documentation',
163     author, 'lsquic', 'One line description of project.',
164     'Miscellaneous'),
165]
166
167
168# -- Options for Epub output -------------------------------------------------
169
170# Bibliographic Dublin Core info.
171epub_title = project
172
173# The unique identifier of the text. This can be a ISBN number
174# or the project homepage.
175#
176# epub_identifier = ''
177
178# A unique identification for the text.
179#
180# epub_uid = ''
181
182# A list of files that should not be packed into the epub file.
183epub_exclude_files = ['search.html']
184