casalogger package for CASA 6
Source
xxxxxxxxxx
# 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 (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.
# For extensions
from os.path import dirname, abspath, join
import sys
import os
sys.path.insert(0, abspath(join(dirname(__file__),'..','..','src'))) # For autoapi
# -- Project information -----------------------------------------------------
project = 'casalogger'
copyright = '2022, CASA visualization team'
author = 'CASA visualization team'
# The full version, including alpha/beta/rc tags
release = '0.0.1'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [ 'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.todo',
'autoapi.extension'
]
# configure autoapi
autoapi_dirs = ['../../src/casalogger' ]
autoapi_add_toctree_entry = False
autoapi_generate_api_docs = True
autoapi_root = '_api/autoapi'
autoapi_options = ['show-module-summary']
autoapi_template_dir = '_templates'
autoapi_keep_files = True
# 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 = []
# -- 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 = 'sphinx_rtd_theme'
html_logo = 'casa_logo-small.png'
# 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 = {
'collapse_navigation': True,
'navigation_depth': 5,
'style_nav_header_background': 'white',
'logo_only': 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 = ['_static']
# tweak the default readthedocs theme
def setup(app):
app.add_css_file('customization.css')