godot-contributing-docs/conf.py at main · AdriaandeJongh/godot-contributing-docs · 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# Configuration file for the Sphinx documentation builder.

# -- Project information

project = 'Contributing to Godot'
copyright = '2025, Godot Engine Contributors'
author = 'Godot Engine Contributors'

release = '0.1'
version = '0.1.0'

# -- General configuration

import sys
import os
sys.path.insert(0, os.path.abspath('./_extensions'))

extensions = [
    "sphinx_tabs.tabs",
    "notfound.extension",
    "sphinxext.opengraph",
    "sphinx_copybutton",
    "sphinxcontrib.video",
    "godot_areas",
    "gdscript",
]

intersphinx_mapping = {
    'python': ('https://docs.python.org/3/', None),
    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']

templates_path = ['_templates']

smartquotes = False

# Pygments (syntax highlighting) style to use
pygments_style = "sphinx"
highlight_language = "gdscript"

# -- Options for HTML output

html_theme = 'sphinx_rtd_theme'

html_theme_options = {
    # if we have a html_logo below, this shows /only/ the logo with no title text
    "logo_only": True,
    'flyout_display': 'hidden',
    # Collapse navigation (False makes it tree-like)
    "collapse_navigation": False,
    # Remove version and language picker beneath the title
    "version_selector": False,
    "language_selector": False,
}

html_context = {
    "display_github": True,
    "github_user": "godotengine",
    "github_repo": "godot-contributing-docs",
    "github_version": "main",
    "conf_py_path": "/",
}

html_logo = "img/docs_logo.svg"
# Set explicitly to avoid the standard title inserting a version.
html_title = 'Contributing to Godot'

# These folders are copied to the documentation's HTML output
html_static_path = ["_static"]

# These paths are either relative to html_static_path
# or fully qualified paths (e.g. https://...)
html_css_files = [
    "css/custom.css",
]

html_js_files = [
    "js/custom.js",
#     ('https://plausible.godot.foundation/js/script.file-downloads.outbound-links.js',
#      {'defer': 'defer', 'data-domain': 'godotengine.org'}),
]

# -- Options for EPUB output
epub_show_urls = 'footnote'


# -- Custom Sphinx roles for UI -------------------------------------------

rst_prolog = """
.. role:: button
   :class: role-button role-ui

.. role:: menu
    :class: role-menu role-ui

.. role:: inspector
    :class: role-ui

.. role:: ui
    :class: role-ui

"""