mirror of
https://github.com/slint-ui/slint.git
synced 2025-09-29 13:24:48 +00:00
3e96d0f930
Co-authored-by: aurindam <aurindam@users.noreply.github.com> Co-authored-by: Simon Hausmann <simon.hausmann@slint.dev>
121 lines
4.4 KiB
Python
121 lines
4.4 KiB
Python
# Copyright © SixtyFPS GmbH <info@slint.dev>
|
|
# SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Software-3.0
|
|
|
|
# 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('.'))
|
|
import textwrap
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
version = "1.9.0"
|
|
|
|
project = "Slint Reference"
|
|
html_title = f'Slint {version} Reference' # Set title here, otherwise it will say "Slint Reference documentation"
|
|
copyright = "SixtyFPS GmbH"
|
|
author = "Slint Developers <info@slint.dev>"
|
|
github_url = "https://github.com/slint-ui/slint"
|
|
|
|
# -- 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 = ["myst_parser", "sphinx_markdown_tables", "sphinx.ext.autosectionlabel", "sphinxcontrib.jquery", "sphinx_tabs.tabs", "sphinx_design", "sphinx_copybutton"]
|
|
|
|
# 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 = [
|
|
"_build",
|
|
"html/_static/collapsible-lists/LICENSE.md",
|
|
"Thumbs.db",
|
|
".DS_Store",
|
|
"README.md",
|
|
]
|
|
|
|
|
|
# -- 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_book_theme"
|
|
html_favicon = "https://slint.dev/favicon.svg"
|
|
html_theme_options = {
|
|
"repository_url": "https://github.com/slint-ui/slint",
|
|
"use_repository_button": True,
|
|
"use_issues_button": True,
|
|
"use_edit_page_button": False,
|
|
"use_download_button": False,
|
|
"use_fullscreen_button": False,
|
|
"home_page_in_toc": True,
|
|
"logo": {
|
|
"text": f'Slint {version} Reference',
|
|
"image_light": "https://slint.dev/logo/slint-logo-small-light.svg",
|
|
"image_dark": "https://slint.dev/logo/slint-logo-small-dark.svg",
|
|
"link": "https://slint.dev"
|
|
},
|
|
"switcher": {
|
|
"json_url": "https://releases.slint.dev/versions.json",
|
|
"version_match": version,
|
|
},
|
|
"extra_footer": "<div><a href=\"https://slint.dev\">https://slint.dev</a></div>",
|
|
"article_header_start": ["toggle-primary-sidebar.html"],
|
|
"article_header_end": ["searchbox.html", "article-header-buttons.html"]
|
|
}
|
|
|
|
html_sidebars = {
|
|
"**": ["version-switcher", "navbar-logo.html", "sbt-sidebar-nav.html"]
|
|
}
|
|
|
|
# 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_js_files = ['expand_tabs.js']
|
|
html_css_files = [
|
|
'https://cdn.jsdelivr.net/npm/typesense-docsearch-css@0.3.0'
|
|
]
|
|
html_show_sourcelink = False
|
|
|
|
myst_enable_extensions = [
|
|
"html_image", "colon_fence", "linkify"
|
|
]
|
|
|
|
myst_url_schemes = {
|
|
"slint-qs": f"https://slint.dev/releases/{version}/docs/quickstart/{{{{path}}}}",
|
|
"slint-cpp": f"https://slint.dev/releases/{version}/docs/cpp/{{{{path}}}}",
|
|
"slint-rust": f"https://slint.dev/releases/{version}/docs/rust/slint/{{{{path}}}}",
|
|
"slint-build-rust": f"https://slint.dev/releases/{version}/docs/rust/slint_build/{{{{path}}}}",
|
|
"slint-node": f"https://slint.dev/releases/{version}/docs/node/{{{{path}}}}",
|
|
"slint-reference": f"https://slint.dev/releases/{version}/docs/slint/{{{{path}}}}",
|
|
'http': None, 'https': None, 'mailto': None,
|
|
}
|
|
|
|
# Annotate h1/h2 elements with anchors
|
|
myst_heading_anchors = 4
|
|
|
|
rst_epilog = """
|
|
"""
|
|
|
|
|
|
def setup(app):
|
|
app.add_css_file("theme_tweak.css")
|