#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# dnsdist documentation build configuration file, created by
# sphinx-quickstart on Thu Feb  9 00:08:08 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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('.'))
import sys
from pathlib import Path

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

sys.path.append(str(Path(".").resolve()))

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    "changelog",
    "depfile",
    "sphinx_immaterial",
    "sphinx_immaterial.apidoc.json.domain",
    "sphinx_lua_ls",
    "sphinxcontrib.fulltoc",
    "sphinxcontrib.httpdomain",
]
primary_domain = "lua"

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

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index_TOC"

# General information about the project.
project = "dnsdist"
copyright = "PowerDNS.COM BV and its contributors"
author = "PowerDNS.COM BV and its contributors"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
# version = '1.3'
# The full version, including alpha/beta/rc tags.
# release = '1.3.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = [
    "_build",
    "Thumbs.db",
    ".DS_Store",
    ".venv",
    "http-api/override.rst",
    "common/zonemetadata.rst",
    "common/endpoint-servers-config.rst",
    "common/secpoll.rst",
    "common/api/*.rst",
    "common/tarball-pgp-keys.rst",
]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

# -- Lua LS Options -------------------------------------------------------

lua_ls_backend = "disable"

# -- Changelog Options ----------------------------------------------------

changelog_render_ticket = "https://github.com/PowerDNS/pdns/issues/%s"
changelog_render_pullreq = "https://github.com/PowerDNS/pdns/pull/%s"
changelog_render_changeset = "https://github.com/PowerDNS/pdns/commit/%s"

changelog_sections = ["New Features", "Improvements", "Bug Fixes", "Removals"]
changelog_inner_tag_sort = [
    "Security",
    "DNS over QUIC",
    "DNS over HTTP3",
    "DNS over HTTPS",
    "DNS over TLS",
    "DNSCrypt",
    "DNSTAP",
    "Protobuf",
    "Performance",
    "Webserver",
    "Metrics",
    "Meson",
    "Open Telemetry",
    "YAML",
]

changelog_hide_tags_in_entry = True

# -- Options for the Sphinx-Immaterial JSON Domain ------------------------
json_schemas = ["guides/webserver-json.yml"]

# -- 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_path = ["_templates"]
html_theme = "sphinx_immaterial"

# 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 = {
    "site_url": "https://dnsdist.org",
    "palette": {"scheme": "powerdns"},
    "features": [
        "content.code.copy",
        "content.tabs.link",
        "navigation.sections",
        "navigation.tabs",
        "navigation.tabs.sticky",
        "navigation.tracking",
        "search.highlight",
        "search.share",
        "search.suggest",
        "toc.follow",
        "toc.integrate",
    ],
}

html_css_files = ["extra.css"]

# 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"]

html_favicon = "_static/favicon.ico"
html_logo = "_static/powerdns_logo_white_orange_rgb.png"

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "dnsdistdoc"

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    "papersize": "a4paper",
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, "dnsdist.tex", "dnsdist", "PowerDNS.COM BV", "manual"),
]

latex_logo = "_static/powerdns-logo-trans.png"


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (
        "manpages/dnsdist.1",
        "dnsdist",
        "A DNS and DoS aware, scriptable loadbalancer",
        [author],
        1,
    )
]


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (
        master_doc,
        "dnsdist",
        "dnsdist",
        author,
        "dnsdist",
        "One line description of project.",
        "Miscellaneous",
    ),
]


# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''

# A unique identification for the text.
#
# epub_uid = ''

# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]

depfile = "sphinx.d"
depfile_stamp = "sphinx.stamp"
