1# Configuration file for the Sphinx documentation builder.
2#
3# This file only contains a selection of the most common options. For a full
4# list see the documentation:
5# https://www.sphinx-doc.org/en/master/usage/configuration.html
6
7# -- Path setup --------------------------------------------------------------
8
9# If extensions (or modules to document with autodoc) are in another directory,
10# add these directories to sys.path here. If the directory is relative to the
11# documentation root, use os.path.abspath to make it absolute, like shown here.
12#
13# import os
14# import sys
15# sys.path.insert(0, os.path.abspath('.'))
16
17import pathlib
18import sys
19sys.path.insert(0, pathlib.Path(__file__).parents[2].resolve().as_posix())
20import cmsisdsp
21
22# -- Project information -----------------------------------------------------
23
24project = 'cmsisdsp'
25copyright = 'Copyright (C) 2010-2022 ARM Limited or its affiliates. All rights reserved.'
26author = 'Christophe Favergeon'
27
28# The full version, including alpha/beta/rc tags
29release = '1.0.1'
30
31
32# -- General configuration ---------------------------------------------------
33
34# Add any Sphinx extension module names here, as strings. They can be
35# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36# ones.
37extensions = ['sphinx.ext.autodoc'
38]
39
40# Add any paths that contain templates here, relative to this directory.
41templates_path = ['_templates']
42
43# List of patterns, relative to source directory, that match files and
44# directories to ignore when looking for source files.
45# This pattern also affects html_static_path and html_extra_path.
46exclude_patterns = []
47
48
49# -- Options for HTML output -------------------------------------------------
50
51# The theme to use for HTML and HTML Help pages.  See the documentation for
52# a list of builtin themes.
53#
54html_theme = 'alabaster'
55
56# Add any paths that contain custom static files (such as style sheets) here,
57# relative to this directory. They are copied after the builtin static files,
58# so a file named "default.css" will overwrite the builtin "default.css".
59html_static_path = ['_static']
60
61