Skip to content

Commit c4fd1a5

Browse files
yosida95yosida95
committed
upgrade Sphinx from 5.x to 9.0.4
1 parent 1d50ad0 commit c4fd1a5

6 files changed

Lines changed: 89 additions & 107 deletions

File tree

‎.github/workflows/build.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
- uses: actions/checkout@v6
1313
- uses: actions/setup-python@v5
1414
with:
15-
python-version: '3.10'
15+
python-version: '3.12'
1616
cache: 'pip'
1717
- run: pip install -r requirements.txt
1818
- run: make html

‎requirements.in‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Sphinx ~= 9.0.0
2+
sphinx-sitemap ~= 2.9.0

‎requirements.txt‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
1-
Sphinx ~= 5.0
2-
sphinx-sitemap ~= 2.5
1+
# This file was autogenerated by uv via the following command:
2+
# uv pip compile ./requirements.in -o requirements.txt --python-version 3.12
3+
alabaster==0.7.16
4+
# via sphinx
5+
babel==2.17.0
6+
# via sphinx
7+
certifi==2025.11.12
8+
# via requests
9+
charset-normalizer==3.4.4
10+
# via requests
11+
docutils==0.21.2
12+
# via sphinx
13+
idna==3.11
14+
# via requests
15+
imagesize==1.4.1
16+
# via sphinx
17+
jinja2==3.1.6
18+
# via sphinx
19+
markupsafe==3.0.3
20+
# via jinja2
21+
packaging==25.0
22+
# via sphinx
23+
pygments==2.19.2
24+
# via sphinx
25+
requests==2.32.5
26+
# via sphinx
27+
roman-numerals==4.0.0
28+
# via sphinx
29+
snowballstemmer==3.0.1
30+
# via sphinx
31+
sphinx==9.0.4
32+
# via
33+
# -r ./requirements.in
34+
# sphinx-last-updated-by-git
35+
sphinx-last-updated-by-git==0.3.8
36+
# via sphinx-sitemap
37+
sphinx-sitemap==2.9.0
38+
# via -r ./requirements.in
39+
sphinxcontrib-applehelp==2.0.0
40+
# via sphinx
41+
sphinxcontrib-devhelp==2.0.0
42+
# via sphinx
43+
sphinxcontrib-htmlhelp==2.1.0
44+
# via sphinx
45+
sphinxcontrib-jsmath==1.0.1
46+
# via sphinx
47+
sphinxcontrib-qthelp==2.0.0
48+
# via sphinx
49+
sphinxcontrib-serializinghtml==2.0.0
50+
# via sphinx
51+
urllib3==2.6.2
52+
# via requests

‎source/_static/.gitkeep‎

Whitespace-only changes.

‎source/_themes/gws_api_docs/layout.html‎

Lines changed: 13 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,14 @@
1-
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
2-
(sidebars != []) %}
3-
{%- set url_root = pathto('', 1) %}
4-
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
5-
{%- if not embedded and docstitle %}
6-
{%- set titlesuffix = " — "|safe + docstitle|e %}
7-
{%- else %}
8-
{%- set titlesuffix = "" %}
9-
{%- endif -%}
1+
{% extends "basic/layout.html" %}
102

11-
<!DOCTYPE html>
12-
{%- if html_tag %}
13-
{{ html_tag }}
14-
{%- else %}
15-
<html{% if language is not none %} lang="{{ language }}"{% endif %}>
16-
{%- endif %}
17-
<head>
18-
<meta charset="utf-8">
19-
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
20-
21-
{%- block htmltitle %}
22-
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
23-
{%- endblock %}
24-
25-
{%- block css %}
26-
{%- for css in css_files %}
27-
{%- if css|attr("filename") %}
28-
{{ css_tag(css) }}
3+
{%- block htmltitle %}
4+
{%- if not embedded and docstitle %}
5+
<title>{{ title|striptags|e }} &mdash; {{ docstitle|e }}</title>
296
{%- else %}
30-
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
31-
{%- endif %}
32-
{%- endfor %}
33-
{%- endblock %}
34-
35-
{%- if not embedded %}
36-
{%- block scripts %}
37-
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
38-
{%- for js in script_files %}
39-
{{ js_tag(js) }}
40-
{%- endfor %}
41-
{%- endblock %}
42-
43-
{%- if favicon %}
44-
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
45-
{%- endif %}
46-
47-
{%- endif %}
48-
49-
{%- block linktags %}
50-
{%- if hasdoc('genindex') %}
51-
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
52-
{%- endif %}
53-
{%- if hasdoc('search') %}
54-
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
55-
{%- endif %}
56-
57-
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto(master_doc) }}" />
58-
{%- if parents %}
59-
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
7+
<title>{{ title|striptags|e }}</title>
608
{%- endif %}
61-
{%- if next %}
62-
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
63-
{%- endif %}
64-
{%- if prev %}
65-
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
66-
{%- endif %}
67-
{%- if pageurl %}
68-
<link rel="canonical" href="{{ pageurl|e }}" />
69-
{%- endif %}
70-
{% endblock %}
9+
{%- endblock %}
7110

72-
{%- block extrahead %} {% endblock %}
73-
</head>
74-
{%- block body_tag %}<body>{% endblock %}
11+
{% block content %}
7512
<div id="container">
7613
<header>
7714
<div class="logo-area">
@@ -87,13 +24,7 @@
8724
</header>
8825

8926
<div id="content">
90-
{%- if render_sidebar %}
91-
<aside class="sphinxsidebar" role="navigation" aria-label="main navigation">
92-
{%- for sidebartemplate in sidebars %}
93-
{%- include sidebartemplate %}
94-
{%- endfor %}
95-
</aside>
96-
{%- endif %}
27+
{{ sidebar() }}
9728

9829
<div id="main">
9930
<nav id="navigation">
@@ -106,25 +37,24 @@
10637
</ul>
10738
</nav>
10839

109-
{%- block content %}
11040
<main class="document">
11141
{%- block document %}
11242
<div class="body" role="main">
11343
{% block body %} {% endblock %}
11444
</div>
11545
{%- endblock %}
11646
</main>
117-
{%- endblock %}
11847

119-
{%- block footer %}
12048
<footer>
12149
{%- if show_copyright %}
12250
&copy; {{ copyright }}
12351
{%- endif %}
12452
</footer>
125-
{%- endblock %}
12653
</div>
12754
</div>
12855
</div>
129-
</body>
130-
</html>
56+
{% endblock %}
57+
58+
{% block relbar1 %}{% endblock %}
59+
{% block relbar2 %}{% endblock %}
60+
{% block footer %}{% endblock %}

‎source/_themes/gws_api_docs/static/style.css_t‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ main.document {
139139
flex: 1;
140140
}
141141

142-
aside.sphinxsidebar {
142+
.sphinxsidebar {
143143
width: 250px;
144144
padding: 20px 0;
145145
margin: 0;
@@ -149,79 +149,79 @@ aside.sphinxsidebar {
149149
background: #66b0c1;
150150
}
151151

152-
aside.sphinxsidebar a {
152+
.sphinxsidebar a {
153153
text-decoration: none;
154154
}
155155

156-
aside.sphinxsidebar ul {
156+
.sphinxsidebar ul {
157157
padding: 0 0 0 15px;
158158
margin: 0;
159159
color: #000;
160160
list-style: none;
161161
}
162162

163-
aside.sphinxsidebar ul li a {
163+
.sphinxsidebar ul li a {
164164
display: block;
165165
padding: 8px 0 8px 10px;
166166
font-size: 90%;
167167
color: #eee;
168168
text-decoration: none;
169169
}
170170

171-
aside.sphinxsidebar ul li a:hover {
171+
.sphinxsidebar ul li a:hover {
172172
background: #316874;
173173
}
174174

175-
aside.sphinxsidebar h3,
176-
aside.sphinxsidebar h4 {
175+
.sphinxsidebar h3,
176+
.sphinxsidebar h4 {
177177
padding: 6px 0 6px 10px;
178178
margin: 0 0 5px;
179179
font-weight: normal;
180180
background: #5097a7;
181181
border-right: 10px solid #275661;
182182
}
183183

184-
aside.sphinxsidebar h3 {
184+
.sphinxsidebar h3 {
185185
font-size: 24px;
186186
}
187187

188-
aside.sphinxsidebar h3 a {
188+
.sphinxsidebar h3 a {
189189
color: #fff;
190190
}
191191

192-
aside.sphinxsidebar h4 {
192+
.sphinxsidebar h4 {
193193
font-size: 20px;
194194
}
195195

196-
aside.sphinxsidebar p.blurb {
196+
.sphinxsidebar p.blurb {
197197
margin-top: 0;
198198
font-style: normal;
199199
}
200200

201-
aside.sphinxsidebar p.logo a,
202-
aside.sphinxsidebar h3 a,
203-
aside.sphinxsidebar p.logo a:hover,
204-
aside.sphinxsidebar h3 a:hover {
201+
.sphinxsidebar p.logo a,
202+
.sphinxsidebar h3 a,
203+
.sphinxsidebar p.logo a:hover,
204+
.sphinxsidebar h3 a:hover {
205205
border: none;
206206
}
207207

208-
aside.sphinxsidebar p {
208+
.sphinxsidebar p {
209209
margin: 10px 0;
210210
}
211211

212-
aside.sphinxsidebar ul li.toctree-l1 > a {
212+
.sphinxsidebar ul li.toctree-l1 > a {
213213
font-size: 120%;
214214
}
215215

216-
aside.sphinxsidebar ul li.toctree-l2 > a {
216+
.sphinxsidebar ul li.toctree-l2 > a {
217217
font-size: 110%;
218218
}
219219

220-
aside.sphinxsidebar input {
220+
.sphinxsidebar input {
221221
border: 1px solid #ccc;
222222
}
223223

224-
aside.sphinxsidebar hr {
224+
.sphinxsidebar hr {
225225
width: 50%;
226226
height: 1px;
227227
margin-left: 0;
@@ -548,7 +548,7 @@ a:hover code {
548548
}
549549

550550
@media screen and (width <= 870px) {
551-
aside.sphinxsidebar {
551+
.sphinxsidebar {
552552
display: none;
553553
}
554554

0 commit comments

Comments
 (0)