conf.py

"""Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
"""
# pylint: disable=invalid-name,redefined-builtin

author = 'Xander Harris'
ansible_roles_path = ['.']
ansible_tmp_dir = "/tmp/sphinx-ansible"
autoyaml_root = "."
autoyaml_depth = 10

copyright = '2024, Xander Harris'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

exclude_patterns = [
    '_build',
    'Thumbs.db',
    '.DS_Store',
    '.venv/*',
    '.tmp/*',
    '.pytest_cache/*',
    '.venv/',
]

extensions = [
    'myst_parser',
    'notfound.extension',
    'sphinx_design',
    'sphinx_favicon',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosectionlabel',
    'sphinx.ext.autosummary',
    'sphinx.ext.duration',
    'sphinx.ext.extlinks',
    'sphinx.ext.githubpages',
    'sphinx.ext.intersphinx',
    'sphinx.ext.inheritance_diagram',
    'sphinxcontrib.autoyaml',
    'sphinxcontrib.sphinx_ansible',
]

favicons = [
    {
        "sizes": "16x16",
        "href": "img/ansible-16x16.png",
    },
    {
        "sizes": "32x32",
        "href": "img/ansible-32x32.png",
    },
    {
        "rel": "apple-touch-icon",
        "sizes": "180x180",
        "href": "img/ansible-180x180.png",  # use a local file in _static
    },
]

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_static_path = ['_static']
html_theme = 'sphinx_nefertiti'
html_theme_options = {
    'logo': 'img/ansible.png',
    'repository_url': 'https://github.com/edwardtheharris/ansible-k8s-ca',
    'repository_name': 'ansible k8s ca',
    "style": "blue",
}
myst_dmath_double_inline = True
myst_enable_extensions = [
    "amsmath",
    "attrs_block",
    "attrs_inline",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_admonition",
    "html_image",
    "linkify",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]
myst_title_to_header = True
project = 'Ansible Certificate Authority'
release = '0.0.1'
show_authors = True
source_suffix = {
    '.md': 'markdown'
}
templates_path = ['_templates']