conf.py

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

# -- Project information -----------------------------------------------------

project = 'DART'
copyright = '2022, University Corporation for Atmospheric Research'
author = 'Data Assimilation Research Section'

# The full version, including alpha/beta/rc tags
release = '10.7.2'
master_doc = 'README'

# -- 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_rtd_theme',
     'sphinx.ext.autodoc',
     'sphinx.ext.mathjax'
]

# 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 = ['_build', 'Thumbs.db', '.DS_Store', 'models/gitm/testdata1/*',
        'guide/Manhattan_release.rst',
        'guide/Lanai_release.rst',
        'guide/history/Kodiak_release.rst',
        'guide/history/Jamaica_release.rst',
        'guide/history/Iceland_release.rst',
        'guide/history/hawaii_release.rst',
        'guide/history/Guam_release.rst',
        'guide/history/Fiji_release.rst',
        'guide/Lanai_diffs_from_Kodiak.rst',
        'guide/history/Jamaica_diffs_from_I.rst',
        'guide/history/pre_j_release.rst',
        'guide/history/PostI_diffs_from_I.rst',
        'guide/history/Post_Iceland_release.rst',
        'guide/history/I_diffs_from_workshop.rst',
        'guide/history/pre_hawaii_release.rst',
        'guide/history/pre_guam_release.rst',
        'guide/bitwise_considerations.rst',
        'guide/rma.rst',
        'guide/vertical_conversion.rst',
        'guide/boilerplate/boilerplate.rst',
        'guide/boilerplate/template.rst'

]


# -- 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_show_sphinx = False
html_logo = 'guide/_static/ncar-dart-logo-navy.svg'
html_theme_options = {
    'logo_only': True,
    'includehidden': False
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['guide/_templates']

# 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 = ['guide/_static']

html_css_files = ['css/custom.css']