Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions docs/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ file of this repository, and can be defined in your project's ``conf.py`` via
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'versions_menu': True,
# Toc options
'collapse_navigation': False,
'sticky_navigation': True,
Expand All @@ -49,6 +50,7 @@ Base options
* ``vcs_pageview_mode`` String. Changes how to view files when using `display_github`, `display_gitlab`, etc.
When using Github or Gitlab this can be: `blob` (default), `edit`, or `raw`,
on Bitbucket, this can be either: `view` (default) or `edit`.
* ``versions_menu`` Bool. Whether or not to show the bottom left menu listing the versions and links to VCS repository.

TOC Options
~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions sphinx_rtd_theme/theme.conf
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ display_version = True
prev_next_buttons_location = bottom
style_external_links = False
vcs_pageview_mode =
versions_menu = True
19 changes: 11 additions & 8 deletions sphinx_rtd_theme/versions.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% if READTHEDOCS %}
{%- 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">
Expand All @@ -7,17 +7,18 @@
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
{%- if theme_versions_menu|tobool %}
<dl>
<dt>{{ _('Versions') }}</dt>
{% for slug, url in versions %}
{%- for slug, url in versions %}
<dd><a href="{{ url }}">{{ slug }}</a></dd>
{% endfor %}
{%- endfor %}
</dl>
<dl>
<dt>{{ _('Downloads') }}</dt>
{% for type, url in downloads %}
{%- for type, url in downloads %}
<dd><a href="{{ url }}">{{ type }}</a></dd>
{% endfor %}
{%- endfor %}
</dl>
<dl>
<dt>{{ _('On Read the Docs') }}</dt>
Expand All @@ -29,9 +30,11 @@
</dd>
</dl>
<hr/>
{% trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %}

{%- trans %}Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.{% endtrans %}
{%- else %}
{# This content is injected by an AJAX call to readthedocs.org/readthedocs.com #}
{%- endif %}
</div>
</div>
{% endif %}
{%- endif %}