197 lines
6 KiB
Python
197 lines
6 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# mel.vin GitLab documentation build configuration file, created by
|
|
# sphinx-quickstart on Mon Jul 10 23:38:21 2017.
|
|
#
|
|
# This file is execfile()d with the current directory set to its
|
|
# containing dir.
|
|
#
|
|
# Note that not all possible configuration values are present in this
|
|
# autogenerated file.
|
|
#
|
|
# All configuration values have a default; values that are commented out
|
|
# serve to show the default.
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
#
|
|
# needs_sphinx = '1.0'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = ['sphinxcontrib.plantuml']
|
|
|
|
# plantuml config
|
|
plantuml = '@PLANTUML_PATH@ -config "@PROJECT_SOURCE_DIR@/doc/plantuml.cfg"'
|
|
plantuml_output_format = 'svg_img'
|
|
plantuml_latex_output_format = 'pdf'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = []
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
#
|
|
# source_suffix = ['.rst', '.md']
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = '@PROJECT_NAME@'
|
|
copyright = '@PROJECT_COPYRIGHT@'
|
|
author = '@PROJECT_AUTHOR@'
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
# |version| and |release|, also used in various other places throughout the
|
|
# built documents.
|
|
#
|
|
# The short X.Y version.
|
|
version = '@PROJECT_VERSION@'
|
|
# The full version, including alpha/beta/rc tags.
|
|
release = version
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = 'en'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This patterns also effect to html_static_path and html_extra_path
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'colorful'
|
|
|
|
# The name of a reST role to use as the default role, that is, for text marked
|
|
# up `like this`. The default role can always be set within individual
|
|
# documents using the standard reST default-role directive.
|
|
default_role = 'any'
|
|
|
|
# The default language to highlight source code.
|
|
highlight_language = 'rst'
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
|
|
html_theme = 'alabaster'
|
|
|
|
# Theme options are theme-specific and customize the look and feel of a theme
|
|
# further. For a list of options available for each theme, see the
|
|
# documentation.
|
|
#
|
|
# html_theme_options = {}
|
|
|
|
html_theme_options = {
|
|
'font_family': 'Inconsolata',
|
|
'font_size': '16px',
|
|
'show_powered_by': 'false',
|
|
'description': 'managed by @PROJECT_AUTHOR@',
|
|
'show_related': True,
|
|
}
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ['@DOC_SRC@/_static']
|
|
|
|
# Fix table line wrapping for RTD theme
|
|
# https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html
|
|
# https://github.com/rtfd/sphinx_rtd_theme/pull/432
|
|
html_context = {
|
|
'css_files': ['_static/theme_overrides.css']
|
|
}
|
|
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
# to template names.
|
|
#
|
|
# This is required for the alabaster theme
|
|
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
|
html_sidebars = {
|
|
'**': [
|
|
'about.html',
|
|
'navigation.html',
|
|
'relations.html', # needs 'show_related': True theme option to display
|
|
'searchbox.html',
|
|
]
|
|
}
|
|
|
|
|
|
# -- Options for HTMLHelp output ------------------------------------------
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '@PROJECT_NAME@'
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
latex_elements = {
|
|
# The paper size ('letterpaper' or 'a4paper').
|
|
#
|
|
# 'papersize': 'letterpaper',
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
#
|
|
# 'pointsize': '10pt',
|
|
|
|
# Additional stuff for the LaTeX preamble.
|
|
#
|
|
# 'preamble': '',
|
|
|
|
# Latex figure (float) alignment
|
|
#
|
|
# 'figure_align': 'htbp',
|
|
}
|
|
|
|
# Underscores can cause issues in the generated LaTeX.
|
|
latex_prj_esc = '@PROJECT_NAME@'.replace("_", "\\_")
|
|
latex_aut_esc = '@PROJECT_AUTHOR@'.replace("_", "\\_")
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title,
|
|
# author, documentclass [howto, manual, or own class]).
|
|
latex_documents = [
|
|
(master_doc, '@PROJECT_NAME@.tex', latex_prj_esc,
|
|
latex_aut_esc, 'manual'),
|
|
]
|
|
|
|
# -- Options for manual page output ---------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
(master_doc, '@PROJECT_NAME@', '@PROJECT_DESCRIPTION@',
|
|
'@PROJECT_AUTHOR@', 1)
|
|
]
|
|
|
|
|
|
# -- Options for Texinfo output -------------------------------------------
|
|
|
|
# Grouping the document tree into Texinfo files. List of tuples
|
|
# (source start file, target name, title, author,
|
|
# dir menu entry, description, category)
|
|
texinfo_documents = [
|
|
(master_doc, '@PROJECT_NAME@', '@PROJECT_NAME@',
|
|
'@PROJECT_AUTHOR@', '@PROJECT_NAME@',
|
|
'@PROJECT_DESCRIPTION@', 'Documentation'),
|
|
]
|