Skip to content

Add version buttons and indicator in sidebar header #557

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

Merged
mamoll merged 3 commits into from
Dec 31, 2020
Merged

Add version buttons and indicator in sidebar header #557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96d13a1
Add version dropdown to top of sidebar.
Nov 19, 2020
c8238eb
Update _themes/sphinx_rtd_theme/moveit_version.html
auman66 Dec 4, 2020
2e9b2f3
add lable to dropdown
Dec 4, 2020
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
18 changes: 13 additions & 5 deletions _themes/sphinx_rtd_theme/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,18 @@
<a href="http://moveit.ros.org">
<img src="{{ pathto('_static/logo.png', 1) }}"/>
</a>


<div class="version">
<div class="version-dropdown">
<lable for="version-list">Version:</lable>
<select class="version-list" id="version-list" onchange="this.options[this.selectedIndex].value && (window.location = this.options[this.selectedIndex].value);">
<option value=''>{{ version }}</option>
<option value="http://docs.ros.org/en/melodic/api/moveit_tutorials/html/index.html">Melodic</option>
<option value="http://docs.ros.org/en/kinetic/api/moveit_tutorials/html/index.html">Kinetic</option>
<option value="http://docs.ros.org/en/indigo/api/moveit_tutorials/html/index.html">Indigo (EOL)</option>
</select>
</div>
</div><br>
{% include "searchbox.html" %}

{% endblock %}
Expand Down Expand Up @@ -153,12 +164,9 @@
</div>

</section>

</div>
{% include "versions.html" %}


{% if not embedded %}

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
Expand Down
4 changes: 2 additions & 2 deletions _themes/sphinx_rtd_theme/moveit_version.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<br />
<div class="admonition note">
<p class="first admonition-title">Tutorials Version: Master</p>
<p class="last">This is the latest version, which is actively developed. For beginners, we recommmend the stable <a class="reference external" href="http://docs.ros.org/melodic/api/moveit_tutorials/html/index.html">Melodic tutorials</a>. If you are still running a Kinetic release, please use the <a class="reference external" href="http://docs.ros.org/kinetic/api/moveit_tutorials/html/index.html">Kinetic tutorials.</a></p>
<p class="first admonition-title">Tutorials Version: Noetic</p>
<p class="last">This is the latest version, which is actively developed and best for beginners. If you are still running a Melodic release, please use the <a class="reference external" href="http://docs.ros.org/melodic/api/moveit_tutorials/html/index.html">Melodic tutorials</a>.</p>
</div>
36 changes: 11 additions & 25 deletions _themes/sphinx_rtd_theme/versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,23 @@
{% 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-book"> MoveIt</span>
v: {{ 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>
<dt>Current Versions</dt>
<dd><a href="https://ros-planning.github.io/moveit_tutorials/">Noetic</a></dd>
<dd><a href="http://docs.ros.org/en/melodic/api/moveit_tutorials/html/index.html">Melodic</a></dd>
</dl>
<dl>
<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>
<dt>Old Versions</dt>
<dd><a href="http://docs.ros.org/en/kinetic/api/moveit_tutorials/html/index.html">Kinetic</a></dd>
<dd><a href="http://docs.ros.org/en/indigo/api/moveit_tutorials/html/index.html">Indigo</a></dd>
</dl>
<hr/>
Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>.

</div>
</div>
{% endif %}