• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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#
13import os
14import sys
15sys.path.insert(0, os.path.abspath('../'))
16sys.path.insert(0, os.path.abspath('../testlib'))
17
18
19# -- Project information -----------------------------------------------------
20
21project = 'astcenc'
22copyright = '2020, Arm Limited'
23author = 'Arm Limited'
24
25
26# -- General configuration ---------------------------------------------------
27
28# Add any Sphinx extension module names here, as strings. They can be
29# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30# ones.
31extensions = [
32    'sphinx.ext.autodoc',
33    'sphinx.ext.napoleon',
34    'sphinx.ext.coverage'
35]
36
37# Add any paths that contain templates here, relative to this directory.
38templates_path = ['_templates']
39
40# List of patterns, relative to source directory, that match files and
41# directories to ignore when looking for source files.
42# This pattern also affects html_static_path and html_extra_path.
43exclude_patterns = []
44
45
46# -- Options for HTML output -------------------------------------------------
47
48# The theme to use for HTML and HTML Help pages.  See the documentation for
49# a list of builtin themes.
50#
51html_theme = 'classic'
52
53# Add any paths that contain custom static files (such as style sheets) here,
54# relative to this directory. They are copied after the builtin static files,
55# so a file named "default.css" will overwrite the builtin "default.css".
56html_static_path = ['_static']
57