Skip to content

[Docs] adjust sphinx theme templates for gettext builder #26923

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

Open
hwhsu1231 wants to merge 1 commit into
base: main
Choose a base branch
from
+180 −204
Open

[Docs] adjust sphinx theme templates for gettext builder #26923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 5 additions & 7 deletions site/source/_themes/emscripten_sphinx_rtd_theme/breadcrumbs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
<div role="navigation" aria-label="breadcrumbs navigation">

<div class="breadcrumb-box">
<a class="breadcrumb-box-item" href="{{ pathto(master_doc) }}">Home</a>
{% for doc in parents %}
<a class="breadcrumb-box-item" href="{{ doc.link|e }}">&raquo;&nbsp;{{ doc.title }}</a>
{% endfor %}
<a class="breadcrumb-box-item" href="{{ pathto(master_doc) }}">{% trans %}Home{% endtrans %}</a>
{% for doc in parents %}
<a class="breadcrumb-box-item" href="{{ doc.link|e }}">&raquo;&nbsp;{{ doc.title }}</a>
{% endfor %}
<div class="breadcrumb-box-item">&raquo;&nbsp;{{ title }}</div>
</div>

</div>
</div>
138 changes: 60 additions & 78 deletions site/source/_themes/emscripten_sphinx_rtd_theme/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,106 +1,88 @@
<footer>
{% if next or prev %}
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
{% if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}"/>Next <span class="fa fa-arrow-circle-right"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="fa fa-arrow-circle-left"></span> Previous</a>
{% endif %}
</div>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
{% if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}">{% trans %}Next{% endtrans %} <span class="fa fa-arrow-circle-right"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="fa fa-arrow-circle-left"></span> {% trans %}Previous{% endtrans %}</a>
{% endif %}
</div>
{% endif %}


<!--begin hamishw addition -->



<!-- -->

<!--Footer important links
If no such page exists then nav item is not created. CSS defines which of the long or short version is
displayed. -->
<!-- begin hamishw addition -->

<!-- Footer important links
If no such page exists then nav item is not created. CSS defines which of the long or short version is displayed. -->

{% set footer_links = [
('docs/getting_started/bug_reports', _('Report Bug'), _('Report Bug')),
('docs/introducing_emscripten/emscripten_license', _('Licensing'), _('Licensing')),
('docs/contributing/contributing', _('Contributing'), _('Contributing')),
('https://groups.google.com/forum/#!forum/emscripten-discuss', _('Mailing list'), _('Mailing list')),
('https://github.com/emscripten-core/emscripten/wiki', _('Wiki'), _('Wiki')),
('docs/introducing_emscripten/release_notes', _('Release notes'), _('Release notes')),
('docs/introducing_emscripten/community', _('Blogs'), _('Blogs')),
('docs/introducing_emscripten/community', _('Help'), _('Contact')),
] -%}

<div class="footer-nav-bar" style="">
<div class="footer-options">
{% for document, shorttext, longtext in footer_links %}
{%- if hasdoc(document) %}
<a class="footer-navlink-short" title="{{ shorttext }}" href="{{ pathto(document) }}">{{ shorttext }}</a><a class="footer-navlink-long" title="{{ longtext }}" href="{{ pathto(document) }}">{{ longtext }}</a>
{%- elif document | truncate(4, True, end='') == 'http' %}
<a class="footer-navlink-short external" href="{{ document }}">{{ shorttext }}</a><a class="footer-navlink-long external" href="{{ document }}">{{ longtext }}</a>
{%- else %}
{{ shorttext }}
{%- endif %}
{% endfor %}
</div>
</div>

<!-- {% include "breadcrumbs.html" %} -->


{% set footer_links = [
('docs/getting_started/bug_reports', 'Report Bug', 'Report Bug'),
('docs/introducing_emscripten/emscripten_license', 'Licensing', 'Licensing'),
('docs/contributing/contributing', 'Contributing', 'Contributing'),
('https://groups.google.com/forum/#!forum/emscripten-discuss', 'Mailing list', 'Mailing list'),
('https://github.com/emscripten-core/emscripten/wiki', 'Wiki', 'Wiki'),
('docs/introducing_emscripten/release_notes', 'Release notes', 'Release notes'),
('docs/introducing_emscripten/community', 'Blogs', 'Blogs'),
('docs/introducing_emscripten/community', 'Help', 'Contact'),
] -%}
<!-- {% trans %}<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %} -->
<!-- end hamishw addition -->

<div class="footer-nav-bar" style="">
<div class="footer-options">

{% for document, shorttext, longtext in footer_links %}
{%- if hasdoc(document) %}
<a class="footer-navlink-short" title="{{ shorttext }}" href="{{ pathto(document) }}">{{ shorttext }}</a><a class="footer-navlink-long" title="{{ longtext }}" href="{{ pathto(document) }}">{{ longtext }}</a>
{%- elif document | truncate(4, True, end='') == 'http' %}
<a class="footer-navlink-short external" href="{{ document }}">{{ shorttext }}</a><a class="footer-navlink-long external" href="{{ document }}">{{ longtext }}</a>
{%- else %}
{{ shorttext }}
{%- endif %}
{% endfor %}

</div>



</div>

<!-- {% include "breadcrumbs.html" %} -->

<!-- {% trans %}<a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %} --.
<!--end hamishw addition -->



<!-- end section moved here by hamishw -->
<!-- end section moved here by hamishw -->
<div role="contentinfo" class="copyright-box">
<!-- section moved here by hamishw - needs tidying, which is why it is still in breadcrumbs mode -->
<ul class="wy-breadcrumbs">
<!-- section moved here by hamishw - needs tidying, which is why it is still in breadcrumbs mode -->
<ul class="wy-breadcrumbs">
<li class="wy-breadcrumbs-aside">
{% if display_github %}
<a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" class="fa fa-github"> Edit on GitHub</a>
<a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst" class="fa fa-github">{% trans %}Edit on GitHub{% endtrans %}</a>
{% elif display_bitbucket %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}.rst" class="fa fa-bitbucket"> Edit on Bitbucket</a>
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}.rst" class="fa fa-bitbucket">{% trans %}Edit on Bitbucket{% endtrans %}</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow">{% trans %}View page source{% endtrans %}</a>
{% endif %}
</li>

<li class="wy-breadcrumbs-aside">
{%- if hasdoc('docs/site/about') %}
<a href="{{pathto('docs/site/about')}}">About site</a>
<li class="wy-breadcrumbs-aside">
{%- if hasdoc('docs/site/about') %}
<a href="{{ pathto('docs/site/about') }}">{% trans %}About site{% endtrans %}</a>
{%- endif %}
</li>

<li class="wy-breadcrumbs-aside">
<a href="https://github.com/emscripten-core/emscripten/issues/new?title=Bug%20in%20page:{{title|urlencode()}}%20&body=REPLACE%20THIS%20TEXT%20WITH%20BUG%20DESCRIPTION%20%0A%0AURL:%20{{ url_root }}{{pagename|urlencode()}}&labels=bug">Page bug</a>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/emscripten-core/emscripten/issues/new?title=Bug%20in%20page:{{title|urlencode()}}%20&body=REPLACE%20THIS%20TEXT%20WITH%20BUG%20DESCRIPTION%20%0A%0AURL:%20{{ url_root }}{{pagename|urlencode()}}&labels=bug">{% trans %}Page bug{% endtrans %}</a>
</li>
</ul>

</ul>
<p>
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
{% trans path=pathto('copyright'), copyright=copyright|e -%}
&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.
{%- endtrans %}
{%- else %}
<!-- {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %} -->
&copy; Copyright {{ copyright }} <a href="{{ pathto("docs/contributing/AUTHORS") }}">Emscripten Contributors</a>.
<!-- update theme to remove the translation stuff here - it was breaking due to link to AUTHORS file. This is a cludge to allow specific link to my authors file -->
{% trans path=pathto('docs/contributing/AUTHORS'), copyright=copyright|e -%}
&copy; Copyright {{ copyright }} <a href="{{ path }}">Emscripten Contributors</a>.
{%- endtrans %}
<!-- update theme to remove the translation stuff here - it was breaking due to link to AUTHORS file. This is a cludge to allow specific link to my authors file -->
{%- endif %}
{%- endif %}

{%- if last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}
</p>

</div>


</footer>
Loading
Loading