Skip to content

Upgrade Sphinx from 5.x to 9.0.4 #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yosida95 merged 2 commits into from
Dec 17, 2025
Merged

Upgrade Sphinx from 5.x to 9.0.4 #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8e1fae
remove abandoned deploy scripts
yosida95 Dec 17, 2025
c2edd82
upgrade Sphinx from 5.x to 9.0.4
yosida95 Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- uses: actions/checkout@v6
- uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: '3.12'
cache: 'pip'
- run: pip install -r requirements.txt
- run: make html
10 changes: 0 additions & 10 deletions deploy/production.sh
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions requirements.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Sphinx ~= 9.0.0
sphinx-sitemap ~= 2.9.0
54 changes: 52 additions & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,52 @@
Sphinx ~= 5.0
sphinx-sitemap ~= 2.5
# This file was autogenerated by uv via the following command:
# uv pip compile ./requirements.in -o requirements.txt --python-version 3.12
alabaster==0.7.16
# via sphinx
babel==2.17.0
# via sphinx
certifi==2025.11.12
# via requests
charset-normalizer==3.4.4
# via requests
docutils==0.21.2
# via sphinx
idna==3.11
# via requests
imagesize==1.4.1
# via sphinx
jinja2==3.1.6
# via sphinx
markupsafe==3.0.3
# via jinja2
packaging==25.0
# via sphinx
pygments==2.19.2
# via sphinx
requests==2.32.5
# via sphinx
roman-numerals==4.0.0
# via sphinx
snowballstemmer==3.0.1
# via sphinx
sphinx==9.0.4
# via
# -r ./requirements.in
# sphinx-last-updated-by-git
sphinx-last-updated-by-git==0.3.8
# via sphinx-sitemap
sphinx-sitemap==2.9.0
# via -r ./requirements.in
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
urllib3==2.6.2
# via requests
Empty file added source/_static/.gitkeep
View file
Open in desktop
Empty file.
96 changes: 13 additions & 83 deletions source/_themes/gws_api_docs/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,77 +1,14 @@
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and
(sidebars != []) %}
{%- set url_root = pathto('', 1) %}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{%- if not embedded and docstitle %}
{%- set titlesuffix = " — "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif -%}
{% extends "basic/layout.html" %}

<!DOCTYPE html>
{%- if html_tag %}
{{ html_tag }}
{%- else %}
<html{% if language is not none %} lang="{{ language }}"{% endif %}>
{%- endif %}
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{%- endblock %}

{%- block css %}
{%- for css in css_files %}
{%- if css|attr("filename") %}
{{ css_tag(css) }}
{%- block htmltitle %}
{%- if not embedded and docstitle %}
<title>{{ title|striptags|e }} &mdash; {{ docstitle|e }}</title>
{%- else %}
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" />
{%- endif %}
{%- endfor %}
{%- endblock %}

{%- if not embedded %}
{%- block scripts %}
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- for js in script_files %}
{{ js_tag(js) }}
{%- endfor %}
{%- endblock %}

{%- if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{%- endif %}

{%- endif %}

{%- block linktags %}
{%- if hasdoc('genindex') %}
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
{%- endif %}
{%- if hasdoc('search') %}
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
{%- endif %}

<link rel="top" title="{{ docstitle|e }}" href="{{ pathto(master_doc) }}" />
{%- if parents %}
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
<title>{{ title|striptags|e }}</title>
{%- endif %}
{%- if next %}
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
{%- endif %}
{%- if prev %}
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
{%- endif %}
{%- if pageurl %}
<link rel="canonical" href="{{ pageurl|e }}" />
{%- endif %}
{% endblock %}
{%- endblock %}

{%- block extrahead %} {% endblock %}
</head>
{%- block body_tag %}<body>{% endblock %}
{% block content %}
<div id="container">
<header>
<div class="logo-area">
Expand All @@ -87,13 +24,7 @@
</header>

<div id="content">
{%- if render_sidebar %}
<aside class="sphinxsidebar" role="navigation" aria-label="main navigation">
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
</aside>
{%- endif %}
{{ sidebar() }}

<div id="main">
<nav id="navigation">
Expand All @@ -106,25 +37,24 @@
</ul>
</nav>

{%- block content %}
<main class="document">
{%- block document %}
<div class="body" role="main">
{% block body %} {% endblock %}
</div>
{%- endblock %}
</main>
{%- endblock %}

{%- block footer %}
<footer>
{%- if show_copyright %}
&copy; {{ copyright }}
{%- endif %}
</footer>
{%- endblock %}
</div>
</div>
</div>
</body>
</html>
{% endblock %}

{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
{% block footer %}{% endblock %}
42 changes: 21 additions & 21 deletions source/_themes/gws_api_docs/static/style.css_t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ main.document {
flex: 1;
}

aside.sphinxsidebar {
.sphinxsidebar {
width: 250px;
padding: 20px 0;
margin: 0;
Expand All @@ -149,79 +149,79 @@ aside.sphinxsidebar {
background: #66b0c1;
}

aside.sphinxsidebar a {
.sphinxsidebar a {
text-decoration: none;
}

aside.sphinxsidebar ul {
.sphinxsidebar ul {
padding: 0 0 0 15px;
margin: 0;
color: #000;
list-style: none;
}

aside.sphinxsidebar ul li a {
.sphinxsidebar ul li a {
display: block;
padding: 8px 0 8px 10px;
font-size: 90%;
color: #eee;
text-decoration: none;
}

aside.sphinxsidebar ul li a:hover {
.sphinxsidebar ul li a:hover {
background: #316874;
}

aside.sphinxsidebar h3,
aside.sphinxsidebar h4 {
.sphinxsidebar h3,
.sphinxsidebar h4 {
padding: 6px 0 6px 10px;
margin: 0 0 5px;
font-weight: normal;
background: #5097a7;
border-right: 10px solid #275661;
}

aside.sphinxsidebar h3 {
.sphinxsidebar h3 {
font-size: 24px;
}

aside.sphinxsidebar h3 a {
.sphinxsidebar h3 a {
color: #fff;
}

aside.sphinxsidebar h4 {
.sphinxsidebar h4 {
font-size: 20px;
}

aside.sphinxsidebar p.blurb {
.sphinxsidebar p.blurb {
margin-top: 0;
font-style: normal;
}

aside.sphinxsidebar p.logo a,
aside.sphinxsidebar h3 a,
aside.sphinxsidebar p.logo a:hover,
aside.sphinxsidebar h3 a:hover {
.sphinxsidebar p.logo a,
.sphinxsidebar h3 a,
.sphinxsidebar p.logo a:hover,
.sphinxsidebar h3 a:hover {
border: none;
}

aside.sphinxsidebar p {
.sphinxsidebar p {
margin: 10px 0;
}

aside.sphinxsidebar ul li.toctree-l1 > a {
.sphinxsidebar ul li.toctree-l1 > a {
font-size: 120%;
}

aside.sphinxsidebar ul li.toctree-l2 > a {
.sphinxsidebar ul li.toctree-l2 > a {
font-size: 110%;
}

aside.sphinxsidebar input {
.sphinxsidebar input {
border: 1px solid #ccc;
}

aside.sphinxsidebar hr {
.sphinxsidebar hr {
width: 50%;
height: 1px;
margin-left: 0;
Expand Down Expand Up @@ -548,7 +548,7 @@ a:hover code {
}

@media screen and (width <= 870px) {
aside.sphinxsidebar {
.sphinxsidebar {
display: none;
}

Expand Down