Merge pull request #172 from rosjava/updated_docs

updated docs for 0.1.0 and hydro.

docs/build.gradle

@@ -20,7 +20,7 @@ task javadoc(type: Javadoc) {
   def javaProjects = rootProject.subprojects.findResults {
     (it.name != 'docs') ? it : null
   }
-  source javaProjects.collect { fileTree(dir: "${it.projectDir}/src") }
+  source javaProjects.collect { fileTree(dir: "${it.projectDir}/src/main/java") }
   classpath = files(javaProjects.collect { it.configurations.compile })
   destinationDir = new File("${buildDir}/html", 'javadoc')
 }

docs/src/main/sphinx/building.rst

@@ -1,37 +1,35 @@
 .. _building:
 
-Building android_core
-=====================
+Building
+========
 
-android_core uses the `Gradle`_ build and `Apache Ant`_ build systems.
-`rosmake`_ is not supported.
+android_core uses the `Gradle`_ build system in tandem with an external maven
+repository which supplies dependencies (.jar's and .aar's).
 
 To build debug APKs for all android_core packages, execute the `gradle wrapper`_.
 
 .. code-block:: bash
 
-  roscd android_core
-  ./gradlew debug
+  cd android_core
+  ./gradlew assemble
 
-To build the documentation, you may execute the docs task:
+You may deploy the android libraries (.aar's) to your local maven repository so
+that other android packages outside android_core can use them with:
 
 .. code-block:: bash
+  ./gradlew publishToMavenLocal
 
-  ./gradlew docs
+To build the documentation, you may execute the docs task:
 
-At this point, you may interact with your Android projects as described in the
-`Android documentation`_.
+.. code-block:: bash
 
-Automatic generation of Eclipse project files is not currently supported. To
-create an Eclipse project from an existing ROS Android package:
+  ./gradlew docs
 
-#. From Eclipse, create a new Android project from existing source (your
-   package directory).
-#. Add all the jars in the libs directory to your project's build path.
+At this point, you may interact with your Android projects via Android Studio as described
+in the `RosWiki`_ pages.
 
+.. _RosWiki: http://wiki.ros.org/android/Android Studio
 .. _Gradle: http://www.gradle.org/
-.. _Apache Ant: http://ant.apache.org/
-.. _rosmake: http://ros.org/wiki/rosmake/
 .. _gradle wrapper: http://gradle.org/docs/current/userguide/gradle_wrapper.html
 .. _Android documentation: http://developer.android.com/guide/developing/building/building-cmdline.html
 

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

@@ -28,7 +28,7 @@ needs_sphinx = '1.0'
 extensions = ['sphinx.ext.intersphinx', 'javadoc', 'ros']
 
 intersphinx_mapping = {
-    'rosjava-core': ('http://docs.rosjava.googlecode.com/hg/rosjava_core/html/', None),
+    'rosjava-core': ('http://rosjava.github.io/rosjava_core/latest/', None),
     }
 
 javadoc_root = 'javadoc'
@@ -47,7 +47,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'android_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

@@ -5,55 +5,19 @@ Getting started
 
 Before diving into ROS enabled Android application development, you should be
 familiar with :ref:`rosjava <rosjava-core:getting-started>` and `Android
-application development`_ in general.
+application development`_ in general. Note that any information regarding
+command-line adt and eclipse development is depracating - we have moved early
+to a gradle-`android studio`_ environment.
 
 .. _Android application development: http://developer.android.com/training/index.html
+.. _android studio: http://wiki.ros.org/android/Android Studio
 
 Creating a new Android application
 ----------------------------------
 
-.. note:: This is still a work in progress. There are many obvious limitations
-  and the process will be improved in the near future.
+Refer to the `RosWiki`_ for tutorials.
 
-Currently, the easiest way to create a new application is to create your own
-package in the android_core stack by copying one of the tutorial packages (e.g.
-android_tutorial_pubsub).
-
-.. code-block:: bash
-
-  roscd android_core
-  cp -a android_tutorial_pubsub my_package
-
-After that, modify android_core/settings.gradle to include your new package.
-
-.. code-block:: bash
-
-  rosed android_core/settings.gradle
-  ./gradlew my_package:clean my_package:debug
-
-At this point, you may interact with your Android projects as described in the
-`Android documentation`_. Please start there if the following quick start
-instructions are insufficient for you.
-
-Use `Apache Ant`_ to install your new Android application:
-
-.. code-block:: bash
-
-  roscd my_package
-  ant installd
-
-You can also use ant to build the application. However, if you add, remove, or
-modify a dependency in the build.gradle file, you will need to execute the
-`gradle wrapper`_ as described above in order to update the Android
-application's external dependencies (located in the ``my_package/libs``
-directory).
-
-.. note:: You may also build and run your application from Eclipse. For more
-  information, see :doc:`building`.
-
-.. _Android documentation: http://developer.android.com/guide/developing/building/building-cmdline.html
-.. _Apache Ant: http://ant.apache.org/
-.. _gradle wrapper: http://gradle.org/docs/current/userguide/gradle_wrapper.html
+.. _RosWiki: http://wiki.ros.org/android
 
 .. _life-of-a-rosactivity:
 

docs/src/main/sphinx/index.rst

@@ -4,7 +4,8 @@ android_core
 android_core is a collection of components and examples that are useful for
 developing ROS applications on Android.
 
-Support is best found on http://answers.ros.org/.
+Support is best found on http://answers.ros.org/ and ros-related documentation
+for all things ros-android on the `ros wiki`_.
 
 Please file bugs and feature requests on the rosjava `issues`_ page. Starring
 issues that are important to you will help developers prioritize their work.
@@ -12,8 +13,9 @@ issues that are important to you will help developers prioritize their work.
 In addition to the following documentation, android_core makes liberal use of
 `Javadoc`_.
 
-.. _issues: http://code.google.com/p/rosjava/issues/list
+.. _issues: http://github.com/rosjava/android_core/issues
 .. _Javadoc: javadoc/index.html
+.. _ros wiki: http://wiki.ros.org/android
 
 Contents:
 

docs/src/main/sphinx/installing.rst

@@ -1,40 +1,46 @@
-Installing android_core
-=======================
+Installing
+==========
 
 These instructions assume that you have already completed the rosjava_core
 :ref:`installation <rosjava_core:installing>` and :ref:`build
 <rosjava_core:building>` instructions.
 
-These instructions also assume you are using Ubuntu. However, the differences
-between platforms should be minimal.
+Prerequisites
+-------------
 
 There are a few additional dependencies required for building android_core:
 
-* the `Android SDK`_ and
-* `Apache Ant`_ (e.g. on Ubuntu Lucid: ``sudo apt-get install ant1.8 ant1.8-optional``)
+* `Android Studio & SDK`_
 
-As with rosjava_core, the recommend installation procedure for android_core 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 android_core documentation, you will also need
+Pygments 1.5+ and Sphinx 1.1.3+.
 
 .. code-block:: bash
 
-  cd ~/my_workspace
-  rosws merge http://android.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 android_core documentation, you will also need
-Pygments 1.5+ and Sphinx 1.1.3+.
+As with rosjava_core, this repository 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/android_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 building rosjava packages at the same time) then refer to the `RosWiki`_
+for more details.
 
-.. _rosws tutorial: http://www.ros.org/doc/api/rosinstall/html/rosws_tutorial.html
-.. _Apache Ant: http://ant.apache.org/
-.. _Android SDK: http://developer.android.com/sdk/installing.html
+.. _RosWiki: http://wiki.ros.org/android
+.. _Android Studio & SDK: http://wiki.ros.org/android/Android%20Studio/Download
 

docs/src/main/sphinx/overview.rst

@@ -31,7 +31,7 @@ development of data driven Android UIs (e.g.
 android_gingerbread_mr1 library project
 ---------------------------------------
 
-android_gingerbread_mr1 (API level 9) is the lowest API level supported. It
+android_gingerbread_mr1 (API level 10) is the lowest API level supported. It
 provides the base `Activity`_ (:javadoc:`org.ros.android.RosActivity`) and
 `Service`_ (:javadoc:`org.ros.android.NodeMainExecutorService`) for executing
 and managing the lifecycle of your :javadoc:`org.ros.node.NodeMain`\s.

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], []