Skip to content

Render the banner and switchers in the theme, and drop the settings it now provides #1761

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
jpmckinney merged 3 commits into from
Oct 9, 2026
Merged

Render the banner and switchers in the theme, and drop the settings it now provides #1761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d19e3bd
feat: Render the banner and version switcher in the theme, not with A…
jpmckinney Oct 8, 2026
3067ea7
feat: Build the language switcher from the languages theme option
jpmckinney Oct 8, 2026
2467afa
build: Drop the settings that the theme now provides
jpmckinney Oct 9, 2026
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
Binary file removed docs/_static/favicon-16x16.ico
View file
Open in desktop
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/_templates/footer.html
View file
Open in desktop

This file was deleted.

13 changes: 0 additions & 13 deletions docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,3 @@
<li class="toctree-l1"><a class="reference internal" href="https://data.open-contracting.org/" title="{% trans %}Download OCDS data{% endtrans %}">{% trans %}Data Registry{% endtrans %}</a></li>
</ul>
{% endblock %}

{% block language_options %}
<option>{%trans%}Language{% endtrans %}</option>
<optgroup label="{%trans%}Supported translations{% endtrans %}">
<option value="en">English</option>
<option value="es">Español</option>
<option value="fr">Français</option>
</optgroup>
{% endblock %}

{% block version_options %}
<!--#include virtual="/includes/version-options.html" -->
{% endblock %}
10 changes: 2 additions & 8 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
from glob import glob
from pathlib import Path

import standard_theme
from docutils.nodes import make_id
from ocds_babel.translate import translate
from ocdskit.mapping_sheet import mapping_sheet
Expand Down Expand Up @@ -44,8 +43,6 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "standard_theme" # 'pydata_sphinx_theme'
html_theme_path = [standard_theme.get_html_theme_path()]
html_favicon = "_static/favicon-16x16.ico"
html_static_path = ["_static"]
html_css_files = ["custom.css"]
html_js_files = ["renderjson.js", "script.js"]
Expand All @@ -62,7 +59,7 @@
gettext_compact = False
# `DOMAIN_PREFIX` from `config.mk`.
gettext_domain_prefix = f"{profile_identifier}-" if profile_identifier else ""
locale_dirs = ["locale/", os.path.join(standard_theme.get_html_theme_path(), "locale")]
locale_dirs = ["locale/"]
# We use single quotes for codes, which docutils will change to double quotes.
# https://sourceforge.net/p/docutils/code/HEAD/tree/trunk/docutils/docutils/utils/smartquotes.py
smartquotes = False
Expand All @@ -80,13 +77,10 @@
"analytics_id": "HTWZHRIZ",
}
html_theme_options = {
"analytics_id": "HTWZHRIZ",
"display_version": True,
"root_url": f"/profiles/{profile_identifier}" if profile_identifier else "",
"languages": {"en": "English", "es": "Español", "fr": "Français"},
"short_project": project.replace("Open Contracting Data Standard", "OCDS"),
"copyright": copyright,
"license_name": "Apache License 2.0",
"license_url": f"{repository_url}/blob/HEAD/LICENSE",
"repository_url": repository_url,
}
html_short_title = f"{html_theme_options['short_project']} v{release}"
Expand Down
2 changes: 1 addition & 1 deletion script/update
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ set -eu
main() {
mkdir -p script include tests

for f in .pre-commit-config.yaml .python-version Makefile common-requirements.in common-requirements.txt pyproject.toml .github/dependabot.yml .github/workflows/js.yml .github/workflows/shell.yml docs/_static/favicon-16x16.ico include/common.mk include/prologue.mk script/diff script/update tests/conftest.py tests/test_common.py theme-requirements.txt; do
for f in .pre-commit-config.yaml .python-version Makefile common-requirements.in common-requirements.txt pyproject.toml .github/dependabot.yml .github/workflows/js.yml .github/workflows/shell.yml include/common.mk include/prologue.mk script/diff script/update tests/conftest.py tests/test_common.py theme-requirements.txt; do
curl -sS -o $f https://raw.githubusercontent.com/open-contracting/standard_profile_template/refs/heads/latest/$f
done

Expand Down
Loading