Skip to content
Snippets Groups Projects
Commit 23064a4e authored by Damon Kohler's avatar Damon Kohler
Browse files

Change documentation to use pip.

Rename documentation build task to docs.
Remove specification of ROS version.
parent 90c5dc97
No related branches found
No related tags found
No related merge requests found
......@@ -33,7 +33,7 @@ task copySphinxConf(type: Copy) {
rename 'conf.py.in', 'conf.py'
}
task install(type: Exec, dependsOn: [copySphinxConf, javadoc]) {
task docs(type: Exec, dependsOn: [copySphinxConf, javadoc]) {
commandLine 'make', 'html'
}
......
......@@ -5,18 +5,25 @@ Building rosjava_core
rosjava_core uses the `Gradle`_ build system. `rosmake`_ is not supported.
To build rosjava_core, execute the `gradle wrapper`_:
To build rosjava_core and install it to your local `Maven`_ repository, execute
the `gradle wrapper`_:
.. code-block:: bash
roscd rosjava_core
./gradlew install
If you do not want to build the documentation, you may exclude the docs:install task:
To build the documentation, you may execute the docs task:
.. code-block:: bash
./gradlew install -x docs:install
./gradlew docs
To run the tests, you may execute the test task:
.. code-block:: bash
./gradlew test
To generate Eclipse project files:
......@@ -26,5 +33,6 @@ To generate Eclipse project files:
.. _Gradle: http://www.gradle.org/
.. _rosmake: http://ros.org/wiki/rosmake/
.. _Maven: http://maven.apache.org/
.. _gradle wrapper: http://gradle.org/docs/current/userguide/gradle_wrapper.html
......@@ -6,11 +6,6 @@ Installing rosjava_core
These instructions assume that you have already installed ROS on your system.
See :roswiki:`ROS/Installation` if you need help installing ROS.
When choosing a release to install, please consider that:
* The *oldest* ROS release that rosjava has been tested with is: **Electric**
* The *newest* ROS release that rosjava has been tested with is: **Electric**
These instructions also assume you are using Ubuntu. However, the differences
between platforms should be minimal.
......@@ -20,24 +15,25 @@ insufficient.
.. code-block:: bash
sudo apt-get install python-setuptools
easy_install --prefix ~/.local -U rosinstall
export PATH=$PATH:~/.local/bin
sudo apt-get install python-pip
sudo pip install --upgrade rosinstall
mkdir ~/my_workspace
cd ~/my_workspace
rosws init
rosws merge /opt/ros/electric/.rosinstall
rosws merge http://rosjava.googlecode.com/hg/.rosinstall
rosws update
source setup.bash
.. note:: The rosws tool will remind you as well, but don't forget to source
the appropriate, newly generated setup script.
.. note:: You should source the correct setup script for your shell (e.g.
setup.bash for Bash or setup.zsh for Z shell).
If you would like to build the rosjava_core documentation, you will also need Pygments 1.5+.
If you would like to build the rosjava_core documentation, you will also need
Pygments 1.5+ and Sphinx 1.1.3+.
.. code-block:: bash
easy_install --prefix ~/.local -U pygments
sudo pip install --upgrade sphinx Pygments
.. _rosws tutorial: http://www.ros.org/doc/api/rosinstall/html/rosws_tutorial.html
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment