Skip to content

Docs: fixing broken links and formatting #22

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: fixing broken links and formatting #22

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
4 changes: 2 additions & 2 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
'sphinx.ext.doctest',
'sphinx.ext.graphviz',
'sphinx.ext.intersphinx',
'sphinx.ext.pngmath',
'sphinx.ext.imgmath',
'sphinx.ext.todo',
'sphinx.ext.viewcode']

Expand Down Expand Up @@ -113,7 +113,7 @@

# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'ecto_theme'
html_theme = 'sphinxdoc'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
12 changes: 7 additions & 5 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@
ROS integration
###############

This package defines several ROS interfaces for the :ref:`Object Recognition Kitchen <orkcore:index>`. While ``ORK`` is ROS agnostic, several input/output cells are specific ROS and there is also an RViz plugin.
This package defines several ROS interfaces for the :ref:`Object Recognition
Kitchen <orkcore:index>`. While ORK does not require ROS to run, several
input/output cells are specific to ROS.

* :ref:`ROS messages <msgs>`
* :ref:`Service for Object Info <srv>`
* :ref:`Actionlib Server <actionlib>`
* :ref:`Publishers and Subscribers <pubsub>`
- :ref:`ROS messages <msgs>`
- :ref:`Service for Object Info <srv>`
- :ref:`Actionlib Server <actionlib>`
- :ref:`Publishers and Subscribers <pubsub>`

There is also an :ref:`RViz plugin <orkrviz:rviz>`
2 changes: 2 additions & 0 deletions doc/source/msgs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _msgs:

:orphan:

Messages
########

Expand Down
12 changes: 6 additions & 6 deletions doc/source/server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
Actionlib Server
################

The Actionlib server helps you retrieve the identified objects in the current snapshot.
It is defined as follows:
The Actionlib server helps you retrieve the identified objects in the current
snapshot. It is defined as follows:

.. literalinclude:: ../../../ork_msgs/action/ObjectRecognition.action
.. literalinclude:: ../../../object_recognition_msgs/action/ObjectRecognition.action

To run it, you just need to start it with:


.. code-block:: sh

rosrun object_recognition_ros server -c whatever_config_file.ork

You can also test it using the client:
Expand All @@ -37,7 +37,7 @@ For testing, you can even run the server with a test pipeline:
Service
#######

There is a service to get object information: just query it and it will retrieve anything
that is known about the object. Its definition is as follows:
There is a service to get object information: just query it and it will retrieve
anything that is known about the object. Its definition is as follows:

.. program-output:: rossrv show -r object_recognition_msgs/GetObjectInformation.srv