Emulation/mame
1
0
Fork 0
mirror of https://github.com/mamedev/mame.git synced 2024-05-31 18:37:59 -04:00
Code Issues Packages Projects Releases Wiki Activity

Refactor html docs build process to use new template and env variable

Browse source
This commit is contained in:
Firehawke 2021-12-04 15:31:12 -07:00 committed by GitHub
parent 028d02ba7a
commit 48c2620e3e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 56 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/source/_templates/versions.html Normal file
View file

@ -0,0 +1,14 @@
{% if mamedev_site %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Downloads') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book">Downloads</span>
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dd><a href="https://docs.mamedev.org/_files/MAME.pdf">PDF</a></dd>
<dd><a href="https://docs.mamedev.org/_files/MAME.epub">EPUB</a></dd>
</dl>
</div>
</div>
{% endif %}

9
docs/source/conf.py
View file

@ -262,3 +262,12 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# Add download links at bottom left when the MAMEDEV environment
# varaible is set. See versions.html in the _template folder.
try:
html_context
except NameError:
html_context = dict()
if os.getenv("MAMEDEV") != None:
html_context['mamedev_site'] = True

1
docs/themes/sphinx_rtd_theme/theme.conf vendored
View file

@ -18,4 +18,3 @@ prev_next_buttons_location = bottom
style_external_links = False
style_nav_header_background =
vcs_pageview_mode =
mamedevorg = True

77
docs/themes/sphinx_rtd_theme/versions.html vendored
View file

@ -1,49 +1,34 @@
{% if READTHEDOCS %}
{# Add rst-badge after rst-versions for small badge style. #}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: {{ current_version }}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>{{ _('Versions') }}</dt>
{% for slug, url in versions %}
<dd><a href="{{ url }}">{{ slug }}</a></dd>
{% endfor %}
</dl>
<dl>
<dt>{{ _('Downloads') }}</dt>
{% for type, url in downloads %}
<dd><a href="{{ url }}">{{ type }}</a></dd>
{% endfor %}
</dl>
<dl>
{# Translators: The phrase "Read the Docs" is not translated #}
<dt>{{ _('On Read the Docs') }}</dt>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
</dd>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
</dd>
</dl>
</div>
</div>
{% endif %}
{# This section only gets used when mamedevorg is set to anything in theme.conf #}
{% if theme_mamedevorg %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Downloads') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book">Downloads</span>
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dd><a href="https://docs.mamedev.org/_files/MAME.pdf">PDF</a></dd>
<dd><a href="https://docs.mamedev.org/_files/MAME.epub">EPUB</a></dd>
</dl>
</div>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: {{ current_version }}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>{{ _('Versions') }}</dt>
{% for slug, url in versions %}
<dd><a href="{{ url }}">{{ slug }}</a></dd>
{% endfor %}
</dl>
<dl>
<dt>{{ _('Downloads') }}</dt>
{% for type, url in downloads %}
<dd><a href="{{ url }}">{{ type }}</a></dd>
{% endfor %}
</dl>
<dl>
{# Translators: The phrase "Read the Docs" is not translated #}
<dt>{{ _('On Read the Docs') }}</dt>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/projects/{{ slug }}/?fromdocs={{ slug }}">{{ _('Project Home') }}</a>
</dd>
<dd>
<a href="//{{ PRODUCTION_DOMAIN }}/builds/{{ slug }}/?fromdocs={{ slug }}">{{ _('Builds') }}</a>
</dd>
</dl>
</div>
</div>
{% endif %}

3
docs/update.sh
View file

@ -12,7 +12,8 @@ elif [ $LOCAL = $BASE ]; then
echo "Need to pull"
git pull
make clean
make site
# The environment variable added here adds bottom left download pane.
MAMEDEV=1 make site
elif [ $REMOTE = $BASE ]; then
echo "Need to push"
else