# -*- coding: utf-8 -*-
#
# PySide documentation build configuration file, created by
# sphinx-quickstart on Wed Apr 22 15:04:20 2009.
#
# 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.

import sys
import os
from docutils import nodes
from docutils.parsers.rst import roles

# 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 Path(path).resolve() to make it absolute, like shown here.
sys.path.append('@CMAKE_CURRENT_SOURCE_DIR@')
sys.path.append('@pyside_BINARY_DIR@')
if @HAS_WEBENGINE_WIDGETS@:
    sys.path.append('@CMAKE_CURRENT_SOURCE_DIR@/../../../examples/webenginewidgets/tabbedbrowser')

# -- 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.doctest', 'sphinx.ext.ifconfig',
    'sphinx.ext.coverage', 'sphinx.ext.intersphinx', 'sphinx.ext.todo',
    'sphinx.ext.graphviz', 'inheritance_diagram', 'pysideinclude',
    'sphinx.ext.viewcode',
    'sphinx_design', 'sphinx_copybutton', 'myst_parser', 'sphinx_tags',
    'sphinx_toolbox.collapse', 'sphinx_toolbox.decorators', 'sphinx_reredirects']

myst_enable_extensions = [
    "amsmath",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_admonition",
    "html_image",
    "replacements",
    "smartquotes",
    "strikethrough",
    "substitution",
    "tasklist",
]
myst_heading_anchors = 6

output_format='@DOC_OUTPUT_FORMAT@'

def deco_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
    # Create a reference node
    node = nodes.reference(rawtext, text, refuri='#', **options)
    return [node], []

def setup(app):
    app.add_config_value('output_format', 'qthelp', 'env')
    roles.register_local_role('deco', deco_role)

rst_epilog = """
.. |project| replace:: Qt for Python
.. |pymodname| replace:: PySide6
"""

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

# The suffix of source filenames.
source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

# The encoding of source files.
source_encoding = 'utf-8'

graphviz_output_format = 'svg'  # Enable URLs in inheritance diagrams

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'PySide'
copyright = u'2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 (https://www.gnu.org/licenses/fdl.html) as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.'
# 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 = '@BINDING_API_VERSION@'
# The full version, including alpha/beta/rc tags.
release = '@BINDING_API_VERSION_FULL@'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of documents that shouldn't be included in the build.
#unused_docs = []

# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_patterns = ['_build',
                    'extras',
                    '**README.md']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

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

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'furo'

# 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 = {
    # FIXME: This option is currently enable because on the 'requirements-doc.txt'
    # We are using a fork of the theme, to include this new option.
    # This needs to be removed once the functionality is either upstreamed,
    # or a similar option is provided.
    "collapse_navbar": True,
    "dark_css_variables": {
        "color-brand-primary": "#2cde85",
        "color-brand-content": "#2cde85",
        "color-admonition-title--important": "#2cde85",
        "color-admonition-title-background--important": "#474b53",
        "font-stack": "'Titillium Web', sans-serif",
        "color-background": "rgba(0, 0, 0, 0.9)",
        "color-background-font": "#FFFFFF",
    },
    "light_css_variables": {
        "color-brand-primary": "#27138b",
        "color-brand-content": "#27138b",
        "color-admonition-title--important": "#27138b",
        "font-stack": "'Titillium Web', sans-serif",
        "color-background": "rgba(255, 255, 255, 0.9)",
        "color-background-font": "#000000",
    },
}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_themes']

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Qt for Python'

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "@CMAKE_CURRENT_SOURCE_DIR@/_static/qtforpython.png"

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = "@CMAKE_CURRENT_SOURCE_DIR@/_static/qtforpython.ico"

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

html_css_files = [
    'css/qt_font.css',
    'css/qt_style.css',
]
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# Custom sidebar templates, maps document names to template names.
#html_sidebars = { '' : ''}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = { 'index' : 'index.html'}

# If false, no module index is generated.
#html_use_modindex = True

# If false, no index is generated.
html_use_index = False

# If true, the index is split into individual pages for each letter.
html_split_index = False

# If true, links to the reST sources are added to the pages.
html_show_sourcelink = False

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''

# Output file base name for HTML help builder.
#htmlhelp_basename = 'PySideDoc'

# Link to the shiboken6 sphinx project to enable linking
# between the two projects.
intersphinx_mapping = {'shiboken6': ('shiboken6','@SHIBOKEN_INTERSPHINX_FILE@')}

add_module_names = False

# Skip some warnings when building the documentation with
# 'build_base_docs' due to the lack of qdoc generated files, in charge
# of sphinx modules (autodoc) and references.
if @SKIP_SPHINX_WARNINGS@:
    suppress_warnings = ["autodoc", "autodoc.import_object", "ref.ref"]

# -- Options for qthelp output ---------------------------------------------------
qthelp_theme = 'pysidedocs_qthelp'

# for example tagging based on supported platforms
tags_create_tags = True
tags_create_badges = True
tags_badge_colors = {
    "Android": "info",
}

# link redirection in sphinx
redirects = {
    "gettingstarted/porting_from2.html": "../faq/porting_from2.html",
    "gettingstarted/package_details.html": "../package_details.html",
    "gettingstarted/index.html": "../building_from_source/index.html",
    "gettingstarted/linux.html": "../building_from_source/linux.html",
    "gettingstarted/windows.html": "../building_from_source/windows.html",
    "gettingstarted/macOS.html": "../building_from_source/macOS.html",
    "quickstart.html": "gettingstarted.html"
}

# ignore relative paths when linkcheck is running
# sphinx-build -b linkcheck -j auto -n -c <folder_of_conf.py> <folder_of_rst> <output_dir>
linkcheck_ignore = [
    r'^\.\./',  # Ignore all paths starting with ../
    r'^\./',    # Ignore all paths starting with ./
]
