Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
R
Rosjava Core Gradle
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
CeTI
ROS
ROS Java Packages
Rosjava Core Gradle
Commits
23064a4e
Commit
23064a4e
authored
Apr 26, 2012
by
Damon Kohler
Browse files
Options
Downloads
Patches
Plain Diff
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
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/build.gradle
+1
-1
1 addition, 1 deletion
docs/build.gradle
docs/src/main/sphinx/building.rst
+11
-3
11 additions, 3 deletions
docs/src/main/sphinx/building.rst
docs/src/main/sphinx/installing.rst
+8
-12
8 additions, 12 deletions
docs/src/main/sphinx/installing.rst
with
20 additions
and
16 deletions
docs/build.gradle
+
1
−
1
View file @
23064a4e
...
...
@@ -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'
}
...
...
This diff is collapsed.
Click to expand it.
docs/src/main/sphinx/building.rst
+
11
−
3
View file @
23064a4e
...
...
@@ -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 t
o build the documentation, you may ex
clud
e the docs
:install
task:
T
o build the documentation, you may ex
ecut
e 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
This diff is collapsed.
Click to expand it.
docs/src/main/sphinx/installing.rst
+
8
−
12
View file @
23064a4e
...
...
@@ -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 remin
d
y
ou
as well, but don't forget to source
the appropriate, newly generated setup script
.
.. note::
You shoul
d
s
ou
rce 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 p
ygments
sudo pip
install --
upgrade sphinx P
ygments
.. _rosws tutorial: http://www.ros.org/doc/api/rosinstall/html/rosws_tutorial.html
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment