Skip to content

Commit 2e751ab

Browse files
nmariznmariz
committed
BUG32585611: Fix broken links in X DevAPI reference documentation search
1 parent 205bfc5 commit 2e751ab

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+2046
-114
lines changed

‎CHANGES.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ v8.0.26
1616
- WL#14237: Support query attributes
1717
- BUG#32778827: Raise an error if the _id is different when replacing a document
1818
- BUG#32623479: The X DevAPI returns str for binary types values
19+
- BUG#32585611: Fix broken links in X DevAPI reference documentation search
1920

2021
v8.0.25
2122
=======

‎docs/mysqlx/_themes/sphinx_rtd_theme/__init__.py

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,52 @@
1-
"""Sphinx ReadTheDocs theme.
1+
"""
2+
Sphinx Read the Docs theme.
23
34
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
4-
55
"""
6+
67
from os import path
78

8-
__version__ = '0.3.1'
9+
from sphinx import version_info
10+
from sphinx.locale import _
11+
12+
try:
13+
# Avaliable from Sphinx 1.6
14+
from sphinx.util.logging import getLogger
15+
except ImportError:
16+
from logging import getLogger
17+
18+
19+
__version__ = '0.5.1'
920
__version_full__ = __version__
1021

22+
logger = getLogger(__name__)
23+
1124

1225
def get_html_theme_path():
1326
"""Return list of HTML theme paths."""
1427
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
1528
return cur_dir
1629

30+
31+
def config_initiated(app, config):
32+
theme_options = config.html_theme_options or {}
33+
if theme_options.get('canonical_url'):
34+
logger.warning(
35+
_('The canonical_url option is deprecated, use the html_baseurl option from Sphinx instead.')
36+
)
37+
38+
1739
# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
1840
def setup(app):
19-
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
41+
if version_info >= (1, 6, 0):
42+
# Register the theme that can be referenced without adding a theme path
43+
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
44+
45+
if version_info >= (1, 8, 0):
46+
# Add Sphinx message catalog for newer versions of Sphinx
47+
# See http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_message_catalog
48+
rtd_locale_path = path.join(path.abspath(path.dirname(__file__)), 'locale')
49+
app.add_message_catalog('sphinx', rtd_locale_path)
50+
app.connect('config-inited', config_initiated)
51+
52+
return {'parallel_read_safe': True, 'parallel_write_safe': True}

‎docs/mysqlx/_themes/sphinx_rtd_theme/breadcrumbs.html

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,39 +24,41 @@
2424
{% set display_gitlab = True %}
2525
{% endif %}
2626

27+
{% set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}
28+
2729
<div role="navigation" aria-label="breadcrumbs navigation">
2830

2931
<ul class="wy-breadcrumbs">
3032
{% block breadcrumbs %}
31-
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
33+
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
3234
{% for doc in parents %}
3335
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
3436
{% endfor %}
3537
<li>{{ title }}</li>
3638
{% endblock %}
3739
{% block breadcrumbs_aside %}
3840
<li class="wy-breadcrumbs-aside">
39-
{% if hasdoc(pagename) %}
40-
{% if display_github %}
41+
{% if hasdoc(pagename) and display_vcs_links %}
42+
{% if display_github %}
4143
{% if check_meta and 'github_url' in meta %}
4244
<!-- User defined GitHub URL -->
4345
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
4446
{% else %}
45-
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
47+
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
4648
{% endif %}
4749
{% elif display_bitbucket %}
4850
{% if check_meta and 'bitbucket_url' in meta %}
4951
<!-- User defined Bitbucket URL -->
5052
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
5153
{% else %}
52-
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode|default("view") }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
54+
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ suffix }}?mode={{ theme_vcs_pageview_mode or "view" }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
5355
{% endif %}
5456
{% elif display_gitlab %}
5557
{% if check_meta and 'gitlab_url' in meta %}
5658
<!-- User defined GitLab URL -->
5759
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
5860
{% else %}
59-
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode|default("blob") }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
61+
<a href="https://{{ gitlab_host|default("gitlab.com") }}/{{ gitlab_user }}/{{ gitlab_repo }}/{{ theme_vcs_pageview_mode or "blob" }}/{{ gitlab_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
6062
{% endif %}
6163
{% elif show_source and source_url_prefix %}
6264
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
@@ -71,10 +73,10 @@
7173
{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
7274
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
7375
{% if next %}
74-
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
76+
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
7577
{% endif %}
7678
{% if prev %}
77-
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
79+
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
7880
{% endif %}
7981
</div>
8082
{% endif %}

‎docs/mysqlx/_themes/sphinx_rtd_theme/footer.html

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,61 @@
11
<footer>
2-
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
2+
{%- if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
33
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
4-
{% if next %}
5-
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
6-
{% endif %}
7-
{% if prev %}
8-
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
9-
{% endif %}
4+
{%- if next %}
5+
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
6+
{%- endif %}
7+
{%- if prev %}
8+
<a href="{{ prev.link|e }}" class="btn btn-neutral float-left" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> {{ _('Previous') }}</a>
9+
{%- endif %}
1010
</div>
11-
{% endif %}
11+
{%- endif %}
1212

1313
<hr/>
1414

1515
<div role="contentinfo">
16+
{%- block contentinfo %}
1617
<p>
1718
{%- if show_copyright %}
1819
{%- if hasdoc('copyright') %}
19-
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
20+
{% trans path=pathto('copyright'), copyright=copyright|e %}&#169; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
2021
{%- else %}
21-
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
22+
{% trans copyright=copyright|e %}&#169; Copyright {{ copyright }}.{% endtrans %}
2223
{%- endif %}
2324
{%- endif %}
2425

2526
{%- if build_id and build_url %}
26-
{% trans build_url=build_url, build_id=build_id %}
27-
<span class="build">
28-
Build
29-
<a href="{{ build_url }}">{{ build_id }}</a>.
30-
</span>
31-
{% endtrans %}
27+
<span class="build">
28+
{# Translators: Build is a noun, not a verb #}
29+
{% trans %}Build{% endtrans %}
30+
<a href="{{ build_url }}">{{ build_id }}</a>.
31+
</span>
3232
{%- elif commit %}
33-
{% trans commit=commit %}
34-
<span class="commit">
35-
Revision <code>{{ commit }}</code>.
36-
</span>
37-
{% endtrans %}
38-
{%- elif last_updated %}
39-
{% trans last_updated=last_updated|e %}<br />Last updated on {{ last_updated }}.{% endtrans %}
33+
<span class="commit">
34+
{# Translators: the phrase "revision" comes from Git, referring to a commit #}
35+
{% trans %}Revision{% endtrans %} <code>{{ commit }}</code>.
36+
</span>
37+
{%- endif %}
38+
{%- if last_updated %}
39+
<span class="lastupdated">
40+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
41+
</span>
4042
{%- endif %}
4143

4244
</p>
45+
{%- endblock %}
4346
</div>
4447

4548
{%- if show_sphinx %}
46-
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
49+
{% set sphinx_web = '<a href="https://www.sphinx-doc.org/">Sphinx</a>' %}
50+
{% set readthedocs_web = '<a href="https://readthedocs.org">Read the Docs</a>' %}
51+
{# Translators: the variable "sphinx_web" is a link to the Sphinx project documentation with the text "Sphinx" #}
52+
{% trans sphinx_web=sphinx_web, readthedocs_web=readthedocs_web %}Built with {{ sphinx_web }} using a{% endtrans %}
53+
{# Translators: "theme" refers to a theme for Sphinx, which alters the appearance of the generated documenation #}
54+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">{% trans %}theme{% endtrans %}</a>
55+
{# Translators: this is always used as "provided by Read the Docs", and should not imply Read the Docs is an author of the generated documentation. #}
56+
{% trans %}provided by {{ readthedocs_web }}{% endtrans %}.
4757
{%- endif %}
4858

4959
{%- block extrafooter %} {% endblock %}
5060

5161
</footer>
52-

0 commit comments

Comments
 (0)