Documentation fixes. (#6)

cartographer-project · May 5, 2017 · d900193 · d900193
1 parent 691f298
commit d900193
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 54 deletions.
diff --git a/README.rst b/README.rst
@@ -12,9 +12,9 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 
-=========================================
-Cartographer for Fetch Robotics Platforms
-=========================================
+=============================================
+Cartographer ROS for Fetch Robotics Platforms
+=============================================
 
 |build| |docs| |license|
 
@@ -34,16 +34,16 @@ Robotics`_ platforms via `Cartographer ROS`_.
 Documentation
 =============
 
-You will find complete documentation for using Cartographer with ROS at `our
-Read the Docs site`_.
+You will find complete documentation for using Cartographer ROS with Fetch
+Robotics platforms at `our Read the Docs site`_.
 
-.. _our Read the Docs site: https://google-cartographer-ros-for-fetch-robotics-platforms.readthedocs.io/
+.. _our Read the Docs site: https://google-cartographer-ros-for-fetch-robotics-platforms.readthedocs.io
 
 Contributing
 ============
 
-You can find information about contributing to Cartographer's Fetch Robotics platforms
-support at `our Contribution page`_.
+You can find information about contributing to Cartographer ROS's Fetch Robotics
+platforms support at `our Contribution page`_.
 
 .. _our Contribution page: https://github.com/googlecartographer/cartographer_fetch/blob/master/CONTRIBUTING.md
 

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -16,16 +16,13 @@ cmake_minimum_required (VERSION 2.8.7)
 
 project(cartographer_fetch_docs)
 
-SET(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR})
 find_package(Sphinx)
-
-set(OUTPUT_DIR "${CMAKE_BINARY_DIR}/docs/html")
-
-add_custom_target(build_doc ALL
-    ${SPHINX_EXECUTABLE} -b html
-    ${CMAKE_CURRENT_SOURCE_DIR}/source
-    ${CMAKE_CURRENT_BINARY_DIR}/html
-    COMMENT "Building documentation."
-)
-
-# TODO(hrapp): Install documentation?
+if(SPHINX_FOUND)
+  set(OUTPUT_DIR "${CMAKE_BINARY_DIR}/docs/html")
+  add_custom_target(build_doc ALL
+      ${SPHINX_EXECUTABLE} -b html
+      ${CMAKE_CURRENT_SOURCE_DIR}/source
+      ${CMAKE_CURRENT_BINARY_DIR}/html
+      COMMENT "Building documentation."
+  )
+endif()
diff --git a/docs/FindSphinx.cmake b/docs/FindSphinx.cmake
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -60,7 +60,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'Cartographer for Fetch Robotics Platforms'
+project = u'Cartographer ROS for Fetch Robotics Platforms'
 copyright = u'2016 The Cartographer Authors'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -211,7 +211,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    ('index', 'CartographerFetch.tex', u'Cartographer for Fetch Robotics Platforms Documentation',
+    ('index', 'CartographerFetch.tex', u'Cartographer ROS for Fetch Robotics Platforms Documentation',
      u'The Cartographer Authors', 'manual'),
 ]
 
@@ -240,7 +240,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'cartographer_fetch', u'Cartographer for Fetch Robotics Platforms Documentation',
+    ('index', 'cartographer_fetch', u'Cartographer ROS for Fetch Robotics Platforms Documentation',
      [u'The Cartographer Authors'], 1)
 ]
 
@@ -253,9 +253,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'CartographerFetch', u'Cartographer for Fetch Robotics Platforms Documentation',
-     u'The Cartographer Authors', 'Cartographer for Fetch Robotics Platforms',
-     'Provides integration with Fetch Robotics platforms for Cartographer.', 'Miscellaneous'),
+    ('index', 'CartographerFetch', u'Cartographer ROS for Fetch Robotics Platforms Documentation',
+     u'The Cartographer Authors', 'Cartographer ROS for Fetch Robotics Platforms',
+     'Provides integration with Fetch Robotics platforms for Cartographer ROS.', 'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,9 +12,9 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 
-=========================================
-Cartographer for Fetch Robotics Platforms
-=========================================
+=============================================
+Cartographer ROS for Fetch Robotics Platforms
+=============================================
 
 .. toctree::
    :maxdepth: 2
@@ -50,7 +50,7 @@ using `Ninja <https://ninja-build.org>`_.
     cd catkin_ws
     wstool init src
 
-    # Merge the cartographer_fetch code for dependencies.
+    # Merge the cartographer_fetch.rosinstall file and fetch code for dependencies.
     wstool merge -t src https://raw.githubusercontent.com/googlecartographer/cartographer_fetch/master/cartographer_fetch.rosinstall
     wstool update -t src