eclipse-score.github.io/docs/conf.py at d1afe1a80c7c1ad48336706fea8188a29c78fdbc · eclipse-score/eclipse-score.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# *******************************************************************************
# Copyright (c) 2024 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

# 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

project = "SCORE"
copyright = "2024, Score"
author = "SCORE committers"
release = "0.1"

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

templates_path = ["_templates"]

numfig = True

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

html_theme = "pydata_sphinx_theme"  #  "alabaster"
# html_theme_options = {"page_width": "auto", "body_max_width": "1500"}

html_static_path = ["_assets"]
html_css_files = [
    "css/score.css",
]

# html_logo = "_assets/S-CORE_Logo_white_basic.svg"


html_theme_options = {
    "external_links": [
        {"name": "Docs", "url": "https://eclipse-score.github.io/score/"},
        {
            "name": "Eclipse",
            "url": "https://projects.eclipse.org/projects/automotive.score",
        },
    ],
    "icon_links": [
        {
            "name": "GitHub",
            "url": "https://github.com/eclipse-score",
            "icon": "fa-brands fa-github",
            "type": "fontawesome",
        }
    ],
    "use_edit_page_button": True,  # https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html#add-an-edit-button
    "collapse_navigation": True,
    "logo": {
        "text": "Eclipse S-CORE",
    },
}

html_context = {
    # "github_url": "https://github.com", # or your GitHub Enterprise site
    "github_user": "eclipse-score",
    "github_repo": "eclipse-score.github.io",
    "github_version": "main",
    "doc_path": "docs",
}

# Shows no left sidebar for single files
# Woraround for bug: https://github.com/pydata/pydata-sphinx-theme/issues/1662#issuecomment-1913672649
html_sidebars = {"get_involved": []}