Skip to content

Commit

Permalink
Merge pull request #223 from Levi-Armstrong/kinetic
Browse files Browse the repository at this point in the history
Make changes to work with Read The Docs
  • Loading branch information
marip8 committed Oct 12, 2018
2 parents dff4efc + 0209c10 commit 6a7d599
Show file tree
Hide file tree
Showing 50 changed files with 3,064 additions and 6,055 deletions.
20 changes: 0 additions & 20 deletions gh_pages/Makefile

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

1. Open the folder browser application we opened in the [previous exercise](Navigating-the-Ubuntu-GUI.md). You should see an window like the one below. The icons and text above the main window show the current location of the window in the file system.

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.2?action=AttachFile&do=get&target=1.png)
![](../../_static/ubuntu_file_system.png)

2. The icons at the top constitute the "location bar" of the file browser. While the location bar is very useful for navigating in the GUI, it hides the exact location of the window. You can show the location by pressing _Ctrl+L_. You should see the location bar turn into something like the image below:

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.2?action=AttachFile&do=get&target=2.png)
![](../../_static/ubuntu_file_system_location.png)

3. The folder browser opens up in the user's home folder by default. This folder is typically _/home/<username>_, which in the ROS-Industrial training computer is _/home/ros-industrial_. This folder is the only one which the user has full access to. This is by design for security's sake.

Expand Down
12 changes: 6 additions & 6 deletions gh_pages/_source/prerequisites/Navigating-the-Ubuntu-GUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Don't forget about the [presentation slides](../../_downloads/slides/ROS-I%20Bas
## Task 1: Familiarize Yourself with the Ubuntu Desktop
At the log-in screen, click in the password input box, enter `rosindustrial` for the password, and hit enter. The screen should look like the image below when you log in:

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.1?action=AttachFile&do=get&target=1.png)
![](../../_static/ubuntu_desktop.png)

There are several things you will notice on the desktop:

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.1?action=AttachFile&do=get&target=2.png)
![](../../_static/ubuntu_desktop_details.png)

1. The gear icon on the top right of the screen brings up a menu which allows the user to log out, shut down the computer, access system settings, etc...
2. The bar on the left side shows running and "favorite" applications, connected thumb drives, etc.
Expand All @@ -24,7 +24,7 @@ There are several things you will notice on the desktop:
## Task 2: Open and Inspect an Application
Click on the filing-cabinet icon in the launcher. A window should show up, and your desktop should look like something below:

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.1?action=AttachFile&do=get&target=3.png)
![](../../_static/ubuntu_folder_browser.png)

Things to notice:

Expand All @@ -34,16 +34,16 @@ Things to notice:
* If there is only one window open, this window gets focus.
* If more than one are open, clicking a second time causes all of the windows to show up in the foreground, so that you can choose which window to go to (see below):

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.1?action=AttachFile&do=get&target=4.png)
![](../../_static/ubuntu_inspect.png)

## Task 3: Start an Application & Pin it to the Launcher Bar
Click on the launcher button (top left) and type gedit in the search box. The "Text Editor" application (this is actually gedit) should show up (see below):

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.1?action=AttachFile&do=get&target=5.png)
![](../../_static/ubuntu_start_application.png)

Click on the application. The text editor window should show up on the screen, and the text editor icon should show up on the launcher bar on the left-hand side (see below):

![](http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.1?action=AttachFile&do=get&target=6.png)
![](../../_static/ubuntu_application_pin.png)

1. Right-click on the text editor launch icon, and select "Lock to Launcher".
2. Close the gedit window. The launcher icon should remain after the window closes.
Expand Down
2 changes: 1 addition & 1 deletion gh_pages/_source/prerequisites/The-Linux-Terminal.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

1. To open the terminal, click on the terminal icon:

<p align="center"><img src="http://aeswiki.datasys.swri.edu/rositraining/Exercises/1.1.3?action=AttachFile&do=get&target=1.png"/></p>
![](../../_static/ubuntu_terminal_icon.png)

1. Create a second terminal window, either by:

Expand Down
3 changes: 1 addition & 2 deletions gh_pages/_source/session5/OpenCV-in-Python.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ In this exercise, you will create a new node to determine the angular pose of a
1. Determine orientation using piston sleeve locations
1. Calculate the axis orientation relative to a reference (horizontal) axis

![pump images](https://aeswiki.datasys.swri.edu/rositraining/indigo/Exercises/2A.2?action=AttachFile&do=get&target=pump_images.png
)
![pump images](../../_static/pump_images.png)

## Implementation

Expand Down
8 changes: 4 additions & 4 deletions gh_pages/_source/session6/Using-rqt-tools-for-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ roslaunch myworkcell_support setup.launch
rqt_graph
```
3. Here we can see the basic layout of our Scan-N-Plan application:
![](https://github.com/AustinDeric/images/blob/master/basic_rqt_graph.png)
![](../../_static/basic_rqt_graph.png)
4. In a 3rd terminal, launch the descartes path planner.:
```
rosrun myworkcell_core myworkcell_node
```
5. You must update the graph while the node is running because the graph will not update automatically. After the update, we see our updated ROS network contains out myworkcell_node. Also, The myworkcell_node is publishing a new topic `/move_group/goal` which is subscribed by the move_group node.
![](https://github.com/AustinDeric/images/blob/master/planned_rqt_graph.png)
![](../../_static/planned_rqt_graph.png)

### `rqt_console`: view messages:
Now, we would like to see the output of the path planner. rqt_console is a great gui for viewing ROS topics.
Expand All @@ -41,7 +41,7 @@ rqt_console
rosrun myworkcell_core myworkcell_node
```
3. The rqt_console automatically updates, showing the logic behind the path planner:
![](https://github.com/AustinDeric/images/blob/master/rqt_console_output.png)
![](../../_static/rqt_console_output.png)

### `rqt_plot`: view data plots
rqt_plot is an easy way to plot ROS data in real time. In this example, we will plot robot joint velocities from our path plan.
Expand All @@ -63,5 +63,5 @@ rqt_plot
rosrun myworkcell_core myworkcell_node
```
4. We can see the joint positions streaming in real-time:
![](https://github.com/AustinDeric/images/blob/master/plot.png)
![](../../_static/plot.png)

4 changes: 3 additions & 1 deletion gh_pages/_source/setup/PC-Setup---ROS-Kinetic.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@
## Virtual Machine Configuration (**Recommended**)
The VM method is the most convenient method of utilizing the training materials:

1. [Download virtual box](https://www.virtualbox.org/wiki/Downloads)
1. [Download ROS Kinetic training VM](http://aeswiki.datasys.swri.edu/vm/ROSI_Training_Kinetic_latest.ova)
1. [Import image into virtual box](https://www.virtualbox.org/manual/ch01.html#ovf)
1. Start virtual machine
1. Log into virtual machine, user: ```ros-industrial```, pass: ```rosindustrial``` (no spaces or hyphens)
1. Get the latest changes (Open Terminal).
1. Get the latest changes (Open Terminal).

```
cd ~/industrial_training
git checkout kinetic
Expand Down
Binary file added gh_pages/_static/basic_rqt_graph.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
Binary file added gh_pages/_static/planned_rqt_graph.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/plot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/pump_images.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/rqt_console_output.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_application_pin.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_desktop.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_desktop_details.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_file_system.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_file_system_location.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_folder_browser.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_inspect.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_start_application.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gh_pages/_static/ubuntu_terminal_icon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions gh_pages/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<footer>
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (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 }}" accesskey="n" rel="next">{{ _('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 }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
{% endif %}
</div>
{% endif %}

<hr/>

<div class="footer-override">
<a href="http://rosindustrial.org/ric">
<img src="{{ pathto('_static/footer.jpg', 1) }}"/>
</a>
</div>

<div role="contentinfo">
<p>
{%- if show_copyright %}
{%- if hasdoc('copyright') %}
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}{% endtrans %}
{%- else %}
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}{% endtrans %}
{%- endif %}
{%- endif %}

{%- if build_id and build_url %}
{% trans build_url=build_url, build_id=build_id %}
<span class="build">
Build
<a href="{{ build_url }}">{{ build_id }}</a>.
</span>
{% endtrans %}
{%- elif commit %}
{% trans commit=commit %}
<span class="commit">
Revision <code>{{ commit }}</code>.
</span>
{% endtrans %}
{%- elif last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}

</p>
</div>

{%- if show_sphinx %}
{% 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 %}.
{%- endif %}

{%- block extrafooter %} {% endblock %}

</footer>
39 changes: 39 additions & 0 deletions gh_pages/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{% extends '!layout.html' %}

{% block extrabody %}
<script src="{{ pathto('_static/clipboard.min.js', 1) }}"></script>
{% endblock %}

{% block extracontent %}
<div class="header-override">
<a href="http://rosindustrial.org">
<img src="{{ pathto('_static/logo.jpg', 1) }}"/>
</a>
<p>
<a href="http://rosindustrial.org">ROS-Industrial Website</a>|<a href="http://rosindustrial.org/news">Blog</a>
</p>
</div>
{% endblock %}

{% block footer %}
<script>
var pre = document.getElementsByTagName('pre');
for (var i = 0; i < pre.length; i++) {
var button = document.createElement('button');
button.className = 'btn-copyboard fa fa-copy btn';
pre[i].before(button);
}
var clipboard = new Clipboard('.btn-copyboard', {
target: function(trigger) {return trigger.nextElementSibling;}
});
function showSuccess(elem){elem.setAttribute('class','btn-copyboard fa fa-check btn');}
function sleep (time) {
return new Promise((resolve) => setTimeout(resolve, time));
}
clipboard.on('success',function(e){
showSuccess(e.trigger);
sleep(350).then(() => {e.clearSelection();
e.trigger.setAttribute('class','btn-copyboard fa fa-copy btn');})
});
</script>
{% endblock %}
12 changes: 7 additions & 5 deletions gh_pages/_themes/sphinx_rtd_theme/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,17 @@
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
"""
import os
from os import path

VERSION = (0, 1, 8)

__version__ = ".".join(str(v) for v in VERSION)
__version__ = '0.4.2'
__version_full__ = __version__


def get_html_theme_path():
"""Return list of HTML theme paths."""
cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
cur_dir = path.abspath(path.dirname(path.dirname(__file__)))
return cur_dir

# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app):
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
93 changes: 76 additions & 17 deletions gh_pages/_themes/sphinx_rtd_theme/breadcrumbs.html
Original file line number Diff line number Diff line change
@@ -1,23 +1,82 @@
{# Support for Sphinx 1.3+ page_source_suffix, but don't break old builds. #}

{% if page_source_suffix %}
{% set suffix = page_source_suffix %}
{% else %}
{% set suffix = source_suffix %}
{% endif %}

{% if meta is defined and meta is not none %}
{% set check_meta = True %}
{% else %}
{% set check_meta = False %}
{% endif %}

{% if check_meta and 'github_url' in meta %}
{% set display_github = True %}
{% endif %}

{% if check_meta and 'bitbucket_url' in meta %}
{% set display_bitbucket = True %}
{% endif %}

{% if check_meta and 'gitlab_url' in meta %}
{% set display_gitlab = True %}
{% endif %}

<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">
<li class="wy-breadcrumbs-aside">
{% if pagename != "search" %}
{% if display_github %}
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}/{{ conf_py_path }}{{ pagename }}{{ page_source_suffix }}" class="fa fa-github"> Edit on GitHub</a>
{% elif display_bitbucket %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a>
{% elif show_source and source_url_prefix %}
<a href="{{ source_url_prefix }}{{ pagename }}{{ source_suffix }}">View page source</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
{% endif %}
{% endif %}
</li>
<li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
{% for doc in parents %}
{% block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}">{{ _('Docs') }}</a> &raquo;</li>
{% for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{% endfor %}
<li>{{ title }}</li>
{% endfor %}
<li>{{ title }}</li>
{% endblock %}
{% block breadcrumbs_aside %}
<li class="wy-breadcrumbs-aside">
{% if hasdoc(pagename) %}
{% if display_github %}
{% if check_meta and 'github_url' in meta %}
<!-- User defined GitHub URL -->
<a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
{% else %}
<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>
{% endif %}
{% elif display_bitbucket %}
{% if check_meta and 'bitbucket_url' in meta %}
<!-- User defined Bitbucket URL -->
<a href="{{ meta['bitbucket_url'] }}" class="fa fa-bitbucket"> {{ _('Edit on Bitbucket') }}</a>
{% else %}
<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>
{% endif %}
{% elif display_gitlab %}
{% if check_meta and 'gitlab_url' in meta %}
<!-- User defined GitLab URL -->
<a href="{{ meta['gitlab_url'] }}" class="fa fa-gitlab"> {{ _('Edit on GitLab') }}</a>
{% else %}
<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>
{% endif %}
{% elif show_source and source_url_prefix %}
<a href="{{ source_url_prefix }}{{ pagename }}{{ suffix }}">{{ _('View page source') }}</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
{% endif %}
{% endif %}
</li>
{% endblock %}
</ul>

{% if (theme_prev_next_buttons_location == 'top' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
{% if next %}
<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>
{% endif %}
{% if prev %}
<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>
{% endif %}
</div>
{% endif %}
<hr/>
</div>

0 comments on commit 6a7d599

Please sign in to comment.