Merge pull request ros2#103 from ros2/lint

run doc8 linter

Author: dirk-thomas

.travis.yml

@@ -1,10 +1,11 @@
 language: python
 sudo: false
 install:
-  - pip install sphinx
+  - pip install doc8 sphinx
 script:
   - make html 2> stderr.log
   - cat stderr.log
+  - doc8 --ignore D001 --ignore-path build
   # fail the build for any stderr output
   - if [ -s "stderr.log" ]; then false; fi
 notifications:

source/Concepts.rst

@@ -1,5 +1,5 @@
 
-ROS 2 Concepts 
+ROS 2 Concepts
 ==============
 
 .. toctree::

source/Concepts/Overview-of-ROS-2-concepts.rst

@@ -14,8 +14,8 @@ Quick Overview of Graph Concepts
 --------------------------------
 
 
-* Nodes: A node is an entity that uses ROS to communicate with other nodes. 
-* Messages: ROS data type used when subscribing or publishing to a topic. 
+* Nodes: A node is an entity that uses ROS to communicate with other nodes.
+* Messages: ROS data type used when subscribing or publishing to a topic.
 * Topics: Nodes can publish messages to a topic as well as subscribe to a topic to receive messages.
 * Discovery: The automatic process through which nodes determine how to talk to each other.
 

source/Concepts/ROS-2-Client-Libraries.rst

@@ -60,7 +60,7 @@ Furthermore, having the common core means that maintaining multiple client libra
 Language-specific functionality
 -------------------------------
 
-Client library concepts that require language-specific features/properties are not implemented in the RCL but instead are implemented in each client library. 
+Client library concepts that require language-specific features/properties are not implemented in the RCL but instead are implemented in each client library.
 For example, threading models used by “spin” functions will have implementations that are specific to the language of the client library.
 
 Demo

source/Contributing/Developer-Guide.rst

@@ -151,7 +151,7 @@ For example, everyone should have a PEP8 checker built into their editor to cut
 
 Also where possible, packages should check style as part of their unit tests to help with the automated detection of style issues (see `ament_lint_auto <https://github.com/ament/ament_lint/blob/master/ament_lint_auto/doc/index.rst>`__).
 
-C 
+C
 ^
 
 Standard

source/Contributing/Inter-Sphinx-Support.rst

@@ -39,7 +39,7 @@ Examples of intersphinx in action
 
 Links to **source code** can be created as follows:
 
-.. note::  
+.. note::
 
     Class :class:`vcstools.VcsClient` implements the :meth:`vcstools.VcsClient.checkout` method.
 

source/Contributing/MISRA-Compliance-Guide.rst

@@ -20,7 +20,7 @@ This section tries to give guidance about how to integrate ROS2 into a system th
 **Relation to other sections of this wiki:**
 
 
-* The `Quality Guide <Quality-Guide>` summarizes overall techniques and strategies for producing high quality ROS2 packages.  
+* The `Quality Guide <Quality-Guide>` summarizes overall techniques and strategies for producing high quality ROS2 packages.
 
 What are the MISRA guidelines?
 ------------------------------

source/Contributing/Migration-Guide.rst

@@ -14,7 +14,7 @@ Before being able to migrate a ROS 1 package to ROS 2 all of its dependencies mu
 Migration steps
 ---------------
 
-.. contents:: 
+.. contents::
    :depth: 1
    :local:
 
@@ -76,7 +76,7 @@ Pure Python package
 If the ROS 1 package uses CMake only to invoke the ``setup.py`` file and does not contain anything beside Python code (e.g. also no messages, services, etc.) it should be converted into a pure Python package in ROS 2:
 
 
-* 
+*
   Update or add the build type in the ``package.xml`` file:
 
   .. code-block:: xml
@@ -85,10 +85,10 @@ If the ROS 1 package uses CMake only to invoke the ``setup.py`` file and does no
        <build_type>ament_python</build_type>
      </export>
 
-* 
+*
   Remove the ``CMakeLists.txt`` file
 
-* 
+*
   Update the ``setup.py`` file to be a standard Python setup script
 
 ROS 2 supports Python 3 only.
@@ -100,7 +100,7 @@ Update the *CMakeLists.txt* to use *ament_cmake*
 Apply the following changes to use ``ament_cmake`` instead of ``catkin``:
 
 
-* 
+*
   Set the build type in the ``package.xml`` file export section:
 
   .. code-block:: xml
@@ -109,7 +109,7 @@ Apply the following changes to use ``ament_cmake`` instead of ``catkin``:
        <build_type>ament_cmake</build_type>
      </export>
 
-* 
+*
   Replace the ``find_package`` invocation with ``catkin`` and the ``COMPONENTS`` with:
 
   .. code-block:: cmake
@@ -119,14 +119,14 @@ Apply the following changes to use ``ament_cmake`` instead of ``catkin``:
      # ...
      find_package(componentN REQUIRED)
 
-* 
+*
   Move and update the ``catkin_package`` invocation with:
 
 
-  * 
+  *
     Invoke ``ament_package`` instead but **after** all targets have been registered.
 
-  * 
+  *
     The only valid argument for `ament_package <https://github.com/ament/ament_cmake/blob/master/ament_cmake_core/cmake/core/ament_package.cmake>`__ is ``CONFIG_EXTRAS``.
     All other arguments are covered by separate functions which all need to be invoked *before* ``ament_package``:
 
@@ -137,21 +137,21 @@ Apply the following changes to use ``ament_cmake`` instead of ``catkin``:
   *
     **TODO document ament_export_interfaces?**
 
-* 
+*
   Replace the invocation of ``add_message_files``, ``add_service_files`` and ``generate_messages`` with `rosidl_generate_interfaces <https://github.com/ros2/rosidl/blob/master/rosidl_cmake/cmake/rosidl_generate_interfaces.cmake>`__.
 
 
-  * 
+  *
     The first argument is the ``target_name``.
     If you're building just one library it's ``${PROJECT_NAME}``
 
-  * 
+  *
     Followed by the list of message filenames, relative to the package root.
 
 
     * If you will be using the list of filenames multiple times, it is recommended to compose a list of message files and pass the list to the function for clarity.
 
-  * 
+  *
     The final multi-value-keyword argument fpr ``generate_messages`` is ``DEPENDENCIES`` which requires the list of dependent message packages.
 
     .. code-block:: cmake
@@ -161,17 +161,17 @@ Apply the following changes to use ``ament_cmake`` instead of ``catkin``:
          DEPENDENCIES std_msgs
        )
 
-* 
+*
   Remove any occurrences of the *devel space*.
   Related CMake variables like ``CATKIN_DEVEL_PREFIX`` do not exist anymore.
 
 
   * The ``CATKIN_DEPENDS`` and ``DEPENDS`` arguments are passed to the new function `ament_export_dependencies <https://github.com/ament/ament_cmake/blob/master/ament_cmake_export_dependencies/cmake/ament_export_dependencies.cmake>`__.
 
-* 
+*
   Replace the invocation of ``add_message_files``, ``add_service_files`` and ``generate_messages`` with `rosidl_generate_interfaces <https://github.com/ros2/rosidl/blob/master/rosidl_cmake/cmake/rosidl_generate_interfaces.cmake>`__.
 
-* 
+*
   Remove any occurrences of the *devel space*.
   Related CMake variables like ``CATKIN_DEVEL_PREFIX`` do not exist anymore.
 
@@ -584,7 +584,7 @@ Inside the publishing loop, we use the ``->`` operator to access the ``data`` fi
    //    msg.data = ss.str();
        msg->data = ss.str();
 
-To print a console message, instead of using ``ROS_INFO()``, we use ``RCLCPP_INFO()`` and its various cousins. The key difference is that ``RCLCPP_INFO()`` takes a Logger object as the first argument. 
+To print a console message, instead of using ``ROS_INFO()``, we use ``RCLCPP_INFO()`` and its various cousins. The key difference is that ``RCLCPP_INFO()`` takes a Logger object as the first argument.
 
 .. code-block:: cpp
 

source/Contributing/Set-up-a-new-Linux-CI-node.rst

@@ -36,7 +36,7 @@ In short, make sure the jenkins master can ssh into the new node and run docker.
 
    * ``ssh -i ci_ros2_linux_4.pem ubuntu@IPADDRESS``
 
-#. 
+#.
    Run the following commands
 
    .. code-block:: bash
@@ -53,7 +53,7 @@ In short, make sure the jenkins master can ssh into the new node and run docker.
        sudo usermod -aG docker jenkins
        sudo service docker start
 
-#. 
+#.
    Make sure the jenkins user can run docker
 
    .. code-block:: bash

source/Contributing/Set-up-a-new-macOS-CI-node.rst

@@ -57,7 +57,7 @@ Install JDK for Jenkins.
 Easiest way is to type ``java`` at the terminal and let Apple link you to Oracle’s JDK download.
 I installed the latest JDK 8 (withholding Java 9 for now).
 
-Install Homebrew following instructions at https://brew.sh 
+Install Homebrew following instructions at https://brew.sh
 
 Install ``ssh-askpass`` via homebrew
 
@@ -122,7 +122,7 @@ RTI Connext Specific Instructions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 
-* The Open Robotics license is here (private repo): https://github.com/osrf/rticonnextdds-src/blob/license/rti_license.dat 
+* The Open Robotics license is here (private repo): https://github.com/osrf/rticonnextdds-src/blob/license/rti_license.dat
 * Open the RTI launcher application
 
   * In the RTI launcher, open the file dialog to choose the license file.