mirror of
https://github.com/slint-ui/slint.git
synced 2025-08-30 15:17:25 +00:00
e1e4be2497
* docs: Move the langref to sphinx * docs: Use sphinx to build nighly doc snapshot of langref
83 lines
2.5 KiB
Python
83 lines
2.5 KiB
Python
# Copyright © 2021 SixtyFPS GmbH <info@slint-ui.com>
|
|
# SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-commercial
|
|
|
|
# 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 -----------------------------------------------------
|
|
|
|
project = "Slint Book"
|
|
copyright = "2023, info@slint-ui.com"
|
|
author = "Slint Developers <info@slint-ui.com>"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
version = "1.0.0"
|
|
|
|
# -- 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"]
|
|
|
|
# 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_rtd_theme"
|
|
|
|
html_theme_options = {"collapse_navigation": False}
|
|
|
|
# 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_show_sourcelink = False
|
|
|
|
html_logo = "https://slint-ui.com/logo/slint-logo-small-light.svg"
|
|
|
|
myst_enable_extensions = [
|
|
"html_image",
|
|
]
|
|
|
|
# Annotate h1/h2 elements with anchors
|
|
myst_heading_anchors = 4
|
|
|
|
rst_epilog = """
|
|
"""
|
|
|
|
|
|
def setup(app):
|
|
app.add_css_file("theme_tweak.css")
|