updated docs for 0.1.3 and hydro

docs/src/main/sphinx/best_practices.rst

@@ -16,5 +16,8 @@ example:
 - org.ros.rosjava_geometry
 
 Only core packages (e.g. those in rosjava_core and android_core) should begin
-with org.ros.
+with org.ros. A suitably unique choice for github based repos would be
+the github url followed organization and repository/package name, e.g.
+
+- com.github.rosjava.rosjava_extras
 

docs/src/main/sphinx/building.rst

 .. _building:
 
-Building rosjava_core
-=====================
+Building
+========
 
-rosjava_core uses the `Gradle`_ build system. `rosmake`_ is not supported.
+Gradle
+------
+
+rosjava_core uses the `Gradle`_ build system in tandem with an external maven
+repository which supplies dependencies.
 
 To build rosjava_core and install it to your local `Maven`_ repository, execute
 the `gradle wrapper`_:
 
 .. code-block:: bash
 
-  roscd rosjava_core
+  cd rosjava_core
   ./gradlew install
 
 To build the documentation, you may execute the docs task:
@@ -31,8 +35,17 @@ To generate Eclipse project files, you may execute the eclipse:
 
   ./gradlew eclipse
 
+Catkin
+------
+
+It also has a very minimal catkin wrapper that relays build instructions to the
+underlying gradle builder. This lets the repository be easily built and
+deployed alongside other rosjava repositories in a ros environment. Refer to
+the `RosWiki`_ for more information.
+
+
 .. _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
-
+.. _RosWiki: http://wiki.ros.org/rosjava

docs/src/main/sphinx/conf.py.in

@@ -28,7 +28,7 @@ needs_sphinx = '1.0'
 extensions = ['sphinx.ext.intersphinx', 'javadoc', 'ros']
 
 intersphinx_mapping = {
-  'android-core': ('http://docs.rosjava.googlecode.com/hg/android_core/html/', None),
+  'android-core': ('http://rosjava.github.io/android_core/latest/', None),
   }
 
 javadoc_root = 'javadoc'
@@ -47,7 +47,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'rosjava_core'
-copyright = u'2012, Google, Inc.'
+copyright = u'2013, Google, Inc.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/src/main/sphinx/getting_started.rst

@@ -6,60 +6,11 @@ Getting started
 Creating a new Java package
 ---------------------------
 
-The following steps will be wrapped up in package creation script in the near
-future.
-
-#. Use ``roscreate-pkg`` to create a new package. See
-   :roswiki:`ROS/Tutorials/CreatingPackage`.
-#. Remove the generated ``Makefile`` and ``CMakeLists.txt`` files.
-#. Add a new build.gradle file (see :ref:`build-gradle-example`).
-#. Put your your Java sources in ``src/main/java`` and your tests in ``src/test/java``.
-#. Assuming you have already completed :doc:`building`, you can now call
-   ``gradle build`` to build and test your package.
-
-.. _build-gradle-example:
-
-build.gradle example
-~~~~~~~~~~~~~~~~~~~~
-
-.. code-block:: groovy
-
-  apply plugin: 'java'
-
-  // The Maven plugin is only required if your package is used as a library.
-  apply plugin: 'maven'
-
-  // The Application plugin and mainClassName attribute are only required if
-  // your package is used as a binary.
-  apply plugin: 'application'
-  mainClassName = 'org.ros.RosRun'
-
-  sourceCompatibility = 1.6
-  targetCompatibility = 1.6
-
-  repositories {
-    mavenLocal()
-    maven {
-      url 'http://robotbrains.hideho.org/nexus/content/groups/ros-public'
-    }
-  }
-
-  version = '0.0.0-SNAPSHOT'
-  group = 'ros.my_stack'
-
-  dependencies {
-    compile 'ros.rosjava_core:rosjava:0.0.0-SNAPSHOT'
-  }
-
-If you use the `Maven plugin`_, you may use ``gradle install`` to install your
-package to your local .m2 cache and make it available to other rosjava packages
-on your system.
-
-If you use the `Application plugin`_, you may use ``gradle installApp`` to create
-an executable wrapper for your package.
-
-See the Gradle `Java tutorial`_ for more details.
+Please refer to the `RosWiki`_ for more information on how to create a new
+gradle/catkin project and subprojects. You might also wish to read the 
+Gradle `Java tutorial`_ for more details.
 
+.. _RosWiki: http://wiki.ros.org/rosjava
 .. _Maven plugin: http://gradle.org/docs/current/userguide/maven_plugin.html
 .. _Application plugin: http://gradle.org/docs/current/userguide/application_plugin.html
 .. _Java tutorial: http://gradle.org/docs/current/userguide/tutorial_java_projects.html

docs/src/main/sphinx/index.rst

@@ -7,14 +7,13 @@ and Parameters. It also provides a Java implementation of `roscore`_.
 
 Support is best found on http://answers.ros.org/.
 
-Please file bugs and feature requests on the rosjava `issues`_ page. Starring
-issues that are important to you will help developers prioritize their work.
+Please file bugs and feature requests on the rosjava `issues`_ page.
 
 In addition to the following documentation, rosjava_core makes liberal use of
 `Javadoc`_.
 
 .. _roscore:  http://ros.org/wiki/roscore
-.. _issues: http://code.google.com/p/rosjava/issues/list
+.. _issues: https://github.com/rosjava/rosjava_core
 .. _Javadoc: javadoc/index.html
 
 Contents:

docs/src/main/sphinx/installing.rst

 .. _installing:
 
-Installing rosjava_core
-=======================
+Installing
+==========
 
-These instructions assume that you have already installed ROS on your system.
-See :roswiki:`ROS/Installation` if you need help installing ROS.
+Prerequisites
+-------------
 
-These instructions also assume you are using Ubuntu. However, the differences
-between platforms should be minimal.
+You will need a java implementation - this package has been well tested with openjdk-6,
+but is also likely to work equally as well with other implementations (oraclejdk has
+also had minimal testing).
 
-The recommend installation procedure is to use rosws. See the `rosws tutorial`_
-for more information if you find the following quick start instructions to be
-insufficient.
+If you would like to build the rosjava_core documentation, you will also need
+Pygments 1.5+ and Sphinx 1.1.3+. If you don't have native binaries, then
 
 .. code-block:: bash
 
-  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
+  sudo pip install --upgrade sphinx Pygments
+
 
-.. note:: You should source the correct setup script for your shell (e.g.
-  setup.bash for Bash or setup.zsh for Z shell).
+Non-ROS Installation
+--------------------
 
-If you would like to build the rosjava_core documentation, you will also need
-Pygments 1.5+ and Sphinx 1.1.3+.
+This java package no longer requires a ros environment to be installed. In this case,
+you simply need to clone the github repository
 
 .. code-block:: bash
 
-  sudo pip install --upgrade sphinx Pygments
+  git clone https://github.com/rosjava/rosjava_core
+  git checkout -b hydro origin/hydro
+
+and proceed immediately to the section on :ref:`building`.
+
+ROS Installation
+----------------
+
+If you would like a full ros environment backending your installation (you might
+be generating code for your own custom messages, sequencing builds of multiple rosjava
+repositories or using mixed packages, e.g. java + python) then refer to the `RosWiki`_
+for more details.
 
-.. _rosws tutorial: http://www.ros.org/doc/api/rosinstall/html/rosws_tutorial.html
+.. _RosWiki: http://wiki.ros.org/rosjava
 

docs/src/main/sphinx/ros.py

@@ -18,7 +18,7 @@ from docutils import nodes
 
 
 def make_roswiki_link(name, rawtext, text, lineno, inliner, options={}, content=[]):
-  refuri = 'http://ros.org/wiki/' + text
+  refuri = 'http://wiki.ros.org/' + text
   node = nodes.reference(rawtext, text, refuri=refuri, **options)
   return [node], []