conf.py revision 65113787
10bd32030SDmitri Tikhonov# -*- coding: utf-8 -*-
20bd32030SDmitri Tikhonov#
30bd32030SDmitri Tikhonov# Configuration file for the Sphinx documentation builder.
40bd32030SDmitri Tikhonov#
50bd32030SDmitri Tikhonov# This file does only contain a selection of the most common options. For a
60bd32030SDmitri Tikhonov# full list see the documentation:
70bd32030SDmitri Tikhonov# http://www.sphinx-doc.org/en/master/config
80bd32030SDmitri Tikhonov
90bd32030SDmitri Tikhonov# -- Path setup --------------------------------------------------------------
100bd32030SDmitri Tikhonov
110bd32030SDmitri Tikhonov# If extensions (or modules to document with autodoc) are in another directory,
120bd32030SDmitri Tikhonov# add these directories to sys.path here. If the directory is relative to the
130bd32030SDmitri Tikhonov# documentation root, use os.path.abspath to make it absolute, like shown here.
140bd32030SDmitri Tikhonov#
150bd32030SDmitri Tikhonov# import os
160bd32030SDmitri Tikhonov# import sys
170bd32030SDmitri Tikhonov# sys.path.insert(0, os.path.abspath('.'))
180bd32030SDmitri Tikhonov
190bd32030SDmitri Tikhonov
200bd32030SDmitri Tikhonov# -- Project information -----------------------------------------------------
210bd32030SDmitri Tikhonov
220bd32030SDmitri Tikhonovproject = u'lsquic'
230bd32030SDmitri Tikhonovcopyright = u'2020, LiteSpeed Technologies'
240bd32030SDmitri Tikhonovauthor = u'LiteSpeed Technologies'
250bd32030SDmitri Tikhonov
260bd32030SDmitri Tikhonov# The short X.Y version
2765113787SDmitri Tikhonovversion = u'2.27'
280bd32030SDmitri Tikhonov# The full version, including alpha/beta/rc tags
2965113787SDmitri Tikhonovrelease = u'2.27.0'
300bd32030SDmitri Tikhonov
310bd32030SDmitri Tikhonov
320bd32030SDmitri Tikhonov# -- General configuration ---------------------------------------------------
330bd32030SDmitri Tikhonov
340bd32030SDmitri Tikhonov# If your documentation needs a minimal Sphinx version, state it here.
350bd32030SDmitri Tikhonov#
360bd32030SDmitri Tikhonov# needs_sphinx = '1.0'
370bd32030SDmitri Tikhonov
380bd32030SDmitri Tikhonov# Add any Sphinx extension module names here, as strings. They can be
390bd32030SDmitri Tikhonov# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
400bd32030SDmitri Tikhonov# ones.
410bd32030SDmitri Tikhonovextensions = [
420bd32030SDmitri Tikhonov]
430bd32030SDmitri Tikhonov
440bd32030SDmitri Tikhonov# Add any paths that contain templates here, relative to this directory.
450bd32030SDmitri Tikhonovtemplates_path = ['_templates']
460bd32030SDmitri Tikhonov
470bd32030SDmitri Tikhonov# The suffix(es) of source filenames.
480bd32030SDmitri Tikhonov# You can specify multiple suffix as a list of string:
490bd32030SDmitri Tikhonov#
500bd32030SDmitri Tikhonov# source_suffix = ['.rst', '.md']
510bd32030SDmitri Tikhonovsource_suffix = '.rst'
520bd32030SDmitri Tikhonov
530bd32030SDmitri Tikhonov# The master toctree document.
540bd32030SDmitri Tikhonovmaster_doc = 'index'
550bd32030SDmitri Tikhonov
560bd32030SDmitri Tikhonov# The language for content autogenerated by Sphinx. Refer to documentation
570bd32030SDmitri Tikhonov# for a list of supported languages.
580bd32030SDmitri Tikhonov#
590bd32030SDmitri Tikhonov# This is also used if you do content translation via gettext catalogs.
600bd32030SDmitri Tikhonov# Usually you set "language" from the command line for these cases.
610bd32030SDmitri Tikhonovlanguage = None
620bd32030SDmitri Tikhonov
630bd32030SDmitri Tikhonov# List of patterns, relative to source directory, that match files and
640bd32030SDmitri Tikhonov# directories to ignore when looking for source files.
650bd32030SDmitri Tikhonov# This pattern also affects html_static_path and html_extra_path.
660bd32030SDmitri Tikhonovexclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
670bd32030SDmitri Tikhonov
680bd32030SDmitri Tikhonov# The name of the Pygments (syntax highlighting) style to use.
690bd32030SDmitri Tikhonovpygments_style = None
700bd32030SDmitri Tikhonov
710bd32030SDmitri Tikhonovdefault_role = 'c:func'
720bd32030SDmitri Tikhonovprimary_domain = 'c'
730bd32030SDmitri Tikhonov
740bd32030SDmitri Tikhonov
750bd32030SDmitri Tikhonov# -- Options for HTML output -------------------------------------------------
760bd32030SDmitri Tikhonov
770bd32030SDmitri Tikhonov# The theme to use for HTML and HTML Help pages.  See the documentation for
780bd32030SDmitri Tikhonov# a list of builtin themes.
790bd32030SDmitri Tikhonov#
800bd32030SDmitri Tikhonov#html_theme = 'alabaster'
810bd32030SDmitri Tikhonovhtml_style = '/default.css'
820bd32030SDmitri Tikhonov
830bd32030SDmitri Tikhonov# Theme options are theme-specific and customize the look and feel of a theme
840bd32030SDmitri Tikhonov# further.  For a list of options available for each theme, see the
850bd32030SDmitri Tikhonov# documentation.
860bd32030SDmitri Tikhonov#
870bd32030SDmitri Tikhonov# html_theme_options = {}
880bd32030SDmitri Tikhonov
890bd32030SDmitri Tikhonov# Add any paths that contain custom static files (such as style sheets) here,
900bd32030SDmitri Tikhonov# relative to this directory. They are copied after the builtin static files,
910bd32030SDmitri Tikhonov# so a file named "default.css" will overwrite the builtin "default.css".
920bd32030SDmitri Tikhonovhtml_static_path = ['_static']
930bd32030SDmitri Tikhonov
940bd32030SDmitri Tikhonov# Custom sidebar templates, must be a dictionary that maps document names
950bd32030SDmitri Tikhonov# to template names.
960bd32030SDmitri Tikhonov#
970bd32030SDmitri Tikhonov# The default sidebars (for documents that don't match any pattern) are
980bd32030SDmitri Tikhonov# defined by theme itself.  Builtin themes are using these templates by
990bd32030SDmitri Tikhonov# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
1000bd32030SDmitri Tikhonov# 'searchbox.html']``.
1010bd32030SDmitri Tikhonov#
1020bd32030SDmitri Tikhonov# html_sidebars = {}
1030bd32030SDmitri Tikhonov
1040bd32030SDmitri Tikhonov
1050bd32030SDmitri Tikhonov# -- Options for HTMLHelp output ---------------------------------------------
1060bd32030SDmitri Tikhonov
1070bd32030SDmitri Tikhonov# Output file base name for HTML help builder.
1080bd32030SDmitri Tikhonovhtmlhelp_basename = 'lsquicdoc'
1090bd32030SDmitri Tikhonov
1100bd32030SDmitri Tikhonov
1110bd32030SDmitri Tikhonov# -- Options for LaTeX output ------------------------------------------------
1120bd32030SDmitri Tikhonov
1130bd32030SDmitri Tikhonovlatex_elements = {
1140bd32030SDmitri Tikhonov    # The paper size ('letterpaper' or 'a4paper').
1150bd32030SDmitri Tikhonov    #
1160bd32030SDmitri Tikhonov    # 'papersize': 'letterpaper',
1170bd32030SDmitri Tikhonov
1180bd32030SDmitri Tikhonov    # The font size ('10pt', '11pt' or '12pt').
1190bd32030SDmitri Tikhonov    #
1200bd32030SDmitri Tikhonov    # 'pointsize': '10pt',
1210bd32030SDmitri Tikhonov
1220bd32030SDmitri Tikhonov    # Additional stuff for the LaTeX preamble.
1230bd32030SDmitri Tikhonov    #
1240bd32030SDmitri Tikhonov    # 'preamble': '',
1250bd32030SDmitri Tikhonov
1260bd32030SDmitri Tikhonov    # Latex figure (float) alignment
1270bd32030SDmitri Tikhonov    #
1280bd32030SDmitri Tikhonov    # 'figure_align': 'htbp',
1290bd32030SDmitri Tikhonov}
1300bd32030SDmitri Tikhonov
1310bd32030SDmitri Tikhonov# Grouping the document tree into LaTeX files. List of tuples
1320bd32030SDmitri Tikhonov# (source start file, target name, title,
1330bd32030SDmitri Tikhonov#  author, documentclass [howto, manual, or own class]).
1340bd32030SDmitri Tikhonovlatex_documents = [
1350bd32030SDmitri Tikhonov    (master_doc, 'lsquic.tex', u'lsquic Documentation',
1360bd32030SDmitri Tikhonov     u'LiteSpeed Technologies', 'manual'),
1370bd32030SDmitri Tikhonov]
1380bd32030SDmitri Tikhonov
1390bd32030SDmitri Tikhonov
1400bd32030SDmitri Tikhonov# -- Options for manual page output ------------------------------------------
1410bd32030SDmitri Tikhonov
1420bd32030SDmitri Tikhonov# One entry per manual page. List of tuples
1430bd32030SDmitri Tikhonov# (source start file, name, description, authors, manual section).
1440bd32030SDmitri Tikhonovman_pages = [
1450bd32030SDmitri Tikhonov    (master_doc, 'lsquic', u'lsquic Documentation',
1460bd32030SDmitri Tikhonov     [author], 1)
1470bd32030SDmitri Tikhonov]
1480bd32030SDmitri Tikhonov
1490bd32030SDmitri Tikhonov
1500bd32030SDmitri Tikhonov# -- Options for Texinfo output ----------------------------------------------
1510bd32030SDmitri Tikhonov
1520bd32030SDmitri Tikhonov# Grouping the document tree into Texinfo files. List of tuples
1530bd32030SDmitri Tikhonov# (source start file, target name, title, author,
1540bd32030SDmitri Tikhonov#  dir menu entry, description, category)
1550bd32030SDmitri Tikhonovtexinfo_documents = [
1560bd32030SDmitri Tikhonov    (master_doc, 'lsquic', u'lsquic Documentation',
1570bd32030SDmitri Tikhonov     author, 'lsquic', 'One line description of project.',
1580bd32030SDmitri Tikhonov     'Miscellaneous'),
1590bd32030SDmitri Tikhonov]
1600bd32030SDmitri Tikhonov
1610bd32030SDmitri Tikhonov
1620bd32030SDmitri Tikhonov# -- Options for Epub output -------------------------------------------------
1630bd32030SDmitri Tikhonov
1640bd32030SDmitri Tikhonov# Bibliographic Dublin Core info.
1650bd32030SDmitri Tikhonovepub_title = project
1660bd32030SDmitri Tikhonov
1670bd32030SDmitri Tikhonov# The unique identifier of the text. This can be a ISBN number
1680bd32030SDmitri Tikhonov# or the project homepage.
1690bd32030SDmitri Tikhonov#
1700bd32030SDmitri Tikhonov# epub_identifier = ''
1710bd32030SDmitri Tikhonov
1720bd32030SDmitri Tikhonov# A unique identification for the text.
1730bd32030SDmitri Tikhonov#
1740bd32030SDmitri Tikhonov# epub_uid = ''
1750bd32030SDmitri Tikhonov
1760bd32030SDmitri Tikhonov# A list of files that should not be packed into the epub file.
1770bd32030SDmitri Tikhonovepub_exclude_files = ['search.html']
178