From 7542e0aaf278d1ca8b34be0bb16540444cef5a68 Mon Sep 17 00:00:00 2001 From: Firehawke <34792592+Firehawke@users.noreply.github.com> Date: Mon, 15 Apr 2024 10:22:07 -0700 Subject: docs: Updated RTD to 2.0.0 and removed dependency on jQuery. (#12253) --- docs/source/_templates/versions.html | 13 +- docs/themes/sphinx_rtd_theme/__init__.py | 54 ++++-- docs/themes/sphinx_rtd_theme/breadcrumbs.html | 6 +- docs/themes/sphinx_rtd_theme/footer.html | 2 +- docs/themes/sphinx_rtd_theme/layout.html | 58 +++--- .../locale/da/LC_MESSAGES/sphinx.mo | Bin 0 -> 2514 bytes .../locale/da/LC_MESSAGES/sphinx.po | 206 +++++++++++++++++++++ .../locale/de/LC_MESSAGES/sphinx.mo | Bin 0 -> 2087 bytes .../locale/de/LC_MESSAGES/sphinx.po | 12 +- .../locale/en/LC_MESSAGES/sphinx.mo | Bin 0 -> 457 bytes .../locale/en/LC_MESSAGES/sphinx.po | 14 +- .../locale/es/LC_MESSAGES/sphinx.mo | Bin 0 -> 2567 bytes .../locale/es/LC_MESSAGES/sphinx.po | 38 ++-- .../locale/et/LC_MESSAGES/sphinx.mo | Bin 0 -> 2380 bytes .../locale/et/LC_MESSAGES/sphinx.po | 22 +-- .../locale/fa_IR/LC_MESSAGES/sphinx.mo | Bin 0 -> 2693 bytes .../locale/fa_IR/LC_MESSAGES/sphinx.po | 11 +- .../locale/fr/LC_MESSAGES/sphinx.mo | Bin 0 -> 2522 bytes .../locale/fr/LC_MESSAGES/sphinx.po | 39 ++-- .../locale/hr/LC_MESSAGES/sphinx.mo | Bin 0 -> 575 bytes .../locale/hr/LC_MESSAGES/sphinx.po | 23 +++ .../locale/hu/LC_MESSAGES/sphinx.mo | Bin 0 -> 501 bytes .../locale/hu/LC_MESSAGES/sphinx.po | 23 +++ .../locale/it/LC_MESSAGES/sphinx.mo | Bin 0 -> 2703 bytes .../locale/it/LC_MESSAGES/sphinx.po | 53 ++++-- .../locale/lt/LC_MESSAGES/sphinx.mo | Bin 0 -> 2750 bytes .../locale/lt/LC_MESSAGES/sphinx.po | 45 +++-- .../locale/nl/LC_MESSAGES/sphinx.mo | Bin 0 -> 2549 bytes .../locale/nl/LC_MESSAGES/sphinx.po | 56 ++++-- .../locale/pl/LC_MESSAGES/sphinx.mo | Bin 0 -> 2339 bytes .../locale/pl/LC_MESSAGES/sphinx.po | 10 +- .../locale/pt/LC_MESSAGES/sphinx.mo | Bin 0 -> 2354 bytes .../locale/pt/LC_MESSAGES/sphinx.po | 161 ++++++++++++++++ .../locale/pt_BR/LC_MESSAGES/sphinx.mo | Bin 0 -> 2780 bytes .../locale/pt_BR/LC_MESSAGES/sphinx.po | 51 +++-- .../locale/ru/LC_MESSAGES/sphinx.mo | Bin 0 -> 3449 bytes .../locale/ru/LC_MESSAGES/sphinx.po | 56 ++++-- docs/themes/sphinx_rtd_theme/locale/sphinx.pot | 18 +- .../locale/sv/LC_MESSAGES/sphinx.mo | Bin 0 -> 2132 bytes .../locale/sv/LC_MESSAGES/sphinx.po | 17 +- .../locale/tr/LC_MESSAGES/sphinx.mo | Bin 0 -> 2117 bytes .../locale/tr/LC_MESSAGES/sphinx.po | 17 +- .../locale/zh_CN/LC_MESSAGES/sphinx.mo | Bin 0 -> 2511 bytes .../locale/zh_CN/LC_MESSAGES/sphinx.po | 84 ++++++--- .../locale/zh_TW/LC_MESSAGES/sphinx.mo | Bin 0 -> 506 bytes .../locale/zh_TW/LC_MESSAGES/sphinx.po | 23 +++ docs/themes/sphinx_rtd_theme/search.html | 4 +- docs/themes/sphinx_rtd_theme/searchbox.html | 2 +- .../sphinx_rtd_theme/static/css/badge_only.css | 2 +- docs/themes/sphinx_rtd_theme/static/css/theme.css | 4 +- docs/themes/sphinx_rtd_theme/versions.html | 62 +++---- 51 files changed, 877 insertions(+), 309 deletions(-) create mode 100644 docs/themes/sphinx_rtd_theme/locale/da/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/da/LC_MESSAGES/sphinx.po create mode 100644 docs/themes/sphinx_rtd_theme/locale/de/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/en/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/es/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/et/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/fa_IR/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/fr/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/hr/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/hr/LC_MESSAGES/sphinx.po create mode 100644 docs/themes/sphinx_rtd_theme/locale/hu/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/hu/LC_MESSAGES/sphinx.po create mode 100644 docs/themes/sphinx_rtd_theme/locale/it/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/lt/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/nl/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/pl/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/pt/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/pt/LC_MESSAGES/sphinx.po create mode 100644 docs/themes/sphinx_rtd_theme/locale/pt_BR/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/ru/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/sv/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/tr/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/zh_CN/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/zh_TW/LC_MESSAGES/sphinx.mo create mode 100644 docs/themes/sphinx_rtd_theme/locale/zh_TW/LC_MESSAGES/sphinx.po diff --git a/docs/source/_templates/versions.html b/docs/source/_templates/versions.html index 3e5e6a020af..e4d2ae4731a 100644 --- a/docs/source/_templates/versions.html +++ b/docs/source/_templates/versions.html @@ -1,14 +1,7 @@ {% if mamedev_site %}
- - Downloads - - -
-
-
PDF
-
EPUB
-
-
+ + Download documentation as PDF or EPUB +
{% endif %} diff --git a/docs/themes/sphinx_rtd_theme/__init__.py b/docs/themes/sphinx_rtd_theme/__init__.py index 37c3b10d0fc..2ce88a259e9 100644 --- a/docs/themes/sphinx_rtd_theme/__init__.py +++ b/docs/themes/sphinx_rtd_theme/__init__.py @@ -12,7 +12,7 @@ from sphinx.locale import _ from sphinx.util.logging import getLogger -__version__ = '1.0.0rc1' +__version__ = '2.0.0' __version_full__ = __version__ logger = getLogger(__name__) @@ -31,33 +31,47 @@ def config_initiated(app, config): _('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.') ) + +def extend_html_context(app, pagename, templatename, context, doctree): + # Add ``sphinx_version_info`` tuple for use in Jinja templates + context['sphinx_version_info'] = sphinx_version + + # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package def setup(app): if python_version[0] < 3: - logger.warning("Python 2 is deprecated with sphinx_rtd_theme, update to Python 3") - app.require_sphinx('1.6') - if sphinx_version <= (2, 0, 0): - logger.warning("Sphinx 1.x is deprecated with sphinx_rtd_theme, update to Sphinx 2.x or greater") - if not app.config.html_experimental_html5_writer: - logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme") - else: - if app.config.html4_writer: - logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme") + logger.error("Python 2 is not supported with sphinx_rtd_theme, update to Python 3.") + + app.require_sphinx('5.0') + if app.config.html4_writer: + logger.error("'html4_writer' is not supported with sphinx_rtd_theme.") + + # Since Sphinx 6, jquery isn't bundled anymore and we need to ensure that + # the sphinxcontrib-jquery extension is enabled. + # See: https://dev.readthedocs.io/en/latest/design/sphinx-jquery.html + if sphinx_version >= (6, 0, 0): + # Documentation of Sphinx guarantees that an extension is added and + # enabled at most once. + # See: https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.setup_extension + app.setup_extension("sphinxcontrib.jquery") + # However, we need to call the extension's callback since setup_extension doesn't do it + # See: https://github.com/sphinx-contrib/jquery/issues/23 + from sphinxcontrib.jquery import add_js_files as jquery_add_js_files + jquery_add_js_files(app, app.config) # Register the theme that can be referenced without adding a theme path app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) - if sphinx_version >= (1, 8, 0): - # Add Sphinx message catalog for newer versions of Sphinx - # See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog - rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale') - app.add_message_catalog('sphinx', rtd_locale_path) - app.connect('config-inited', config_initiated) + # Add Sphinx message catalog for newer versions of Sphinx + # See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog + rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale') + app.add_message_catalog('sphinx', rtd_locale_path) + app.connect('config-inited', config_initiated) # sphinx emits the permalink icon for headers, so choose one more in keeping with our theme - if sphinx_version >= (3, 5, 0): - app.config.html_permalinks_icon = "\uf0c1" - else: - app.config.html_add_permalinks = "\uf0c1" + app.config.html_permalinks_icon = "\uf0c1" + + # Extend the default context when rendering the templates. + app.connect("html-page-context", extend_html_context) return {'parallel_read_safe': True, 'parallel_write_safe': True} diff --git a/docs/themes/sphinx_rtd_theme/breadcrumbs.html b/docs/themes/sphinx_rtd_theme/breadcrumbs.html index 005b2ecd6ee..bd45b6d7c2f 100644 --- a/docs/themes/sphinx_rtd_theme/breadcrumbs.html +++ b/docs/themes/sphinx_rtd_theme/breadcrumbs.html @@ -22,11 +22,11 @@