casalogger package for CASA 6
Source
xxxxxxxxxx
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
+
# For extensions
13
+
from os.path import dirname, abspath, join
14
+
import sys
15
+
import os
16
+
sys.path.insert(0, abspath(join(dirname(__file__),'..','..','src'))) # For autoapi
17
+
18
+
# -- Project information -----------------------------------------------------
19
+
20
+
project = 'casalogger'
21
+
copyright = '2022, CASA visualization team'
22
+
author = 'CASA visualization team'
23
+
24
+
# The full version, including alpha/beta/rc tags
25
+
release = '0.0.1'
26
+
27
+
28
+
# -- General configuration ---------------------------------------------------
29
+
30
+
# Add any Sphinx extension module names here, as strings. They can be
31
+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32
+
# ones.
33
+
extensions = [ 'sphinx.ext.autodoc',
34
+
'sphinx.ext.napoleon',
35
+
'sphinx.ext.todo',
36
+
'autoapi.extension'
37
+
]
38
+
39
+
# configure autoapi
40
+
autoapi_dirs = ['../../src/casalogger' ]
41
+
autoapi_add_toctree_entry = False
42
+
autoapi_generate_api_docs = True
43
+
autoapi_root = '_api/autoapi'
44
+
autoapi_options = ['show-module-summary']
45
+
autoapi_template_dir = '_templates'
46
+
autoapi_keep_files = True
47
+
48
+
# Add any paths that contain templates here, relative to this directory.
49
+
templates_path = ['_templates']
50
+
51
+
# List of patterns, relative to source directory, that match files and
52
+
# directories to ignore when looking for source files.
53
+
# This pattern also affects html_static_path and html_extra_path.
54
+
exclude_patterns = []
55
+
56
+
57
+
# -- Options for HTML output -------------------------------------------------
58
+
59
+
# The theme to use for HTML and HTML Help pages. See the documentation for
60
+
# a list of builtin themes.
61
+
#
62
+
html_theme = 'alabaster'
63
+
64
+
# Add any paths that contain custom static files (such as style sheets) here,
65
+
# relative to this directory. They are copied after the builtin static files,
66
+
# so a file named "default.css" will overwrite the builtin "default.css".
67
+
html_static_path = ['_static']