sh_cpl/docs/source/conf.py

71 lines
2.1 KiB
Python
Raw Normal View History

2021-04-14 10:45:39 +02:00
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (ors to document with autodoc) are in another directory,
2021-04-14 10:45:39 +02:00
# 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('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('../../src/'))
2021-04-14 10:45:39 +02:00
# -- Project information -----------------------------------------------------
project = 'Common Python Library'
copyright = '2021, Sven Heidemann'
author = 'Sven Heidemann'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension names here, as strings. They can be
2021-04-14 10:45:39 +02:00
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
2021-05-17 18:32:09 +02:00
'sphinx_rtd_theme',
'myst_parser'
2021-04-14 10:45:39 +02:00
]
2021-05-17 18:32:09 +02:00
source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}
2021-04-14 10:45:39 +02:00
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'cpl_cli/templates/*',
'cpl_cli/*',
2021-11-01 21:17:56 +01:00
'tests',
'cpl_query/tests/*',
'tests/*'
]
2021-04-14 10:45:39 +02:00
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
2021-04-14 10:45:39 +02:00
html_theme = 'sphinx_rtd_theme'
# 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".
2021-11-01 21:17:56 +01:00
html_static_path = ['_static']