Applies multiple ReST markup fixes.

hidmic · hidmic · commit 3304a4f07c5b · 2019-01-04T10:13:28.000-03:00
diff --git a/source/Developer-Guide.rst b/source/Developer-Guide.rst
@@ -45,18 +45,19 @@ Issues
 
 When filing an issue please make sure to:
 
-* Include enough information for another person to understand the issue.
+- Include enough information for another person to understand the issue.
   In ROS 2, the following points are needed for narrowing down the cause of an issue. Testing with as many alternatives in each category as feasible will be especially helpful.
-    - **The operating system and version.** Reasoning: ROS 2 supports multiple platforms, and some bugs are specific to particular versions of operating systems/compilers.
-    - **The installation method.** Reasoning: Some issues only manifest if ROS 2 has been installed from "fat archives" or from Debians. This can help us determine if the issue is with the packaging process.
-    - **The specific version of ROS 2.** Reasoning: Some bugs may be present in a particular ROS 2 release and later fixed. It is important to know if your installation includes these fixes.
-    - **The DDS/RMW implementation being used;** see `this page <Working-with-multiple-RMW-implementations>` for how to determine which one. Reasoning: Communication issues may be specific to the underlying ROS middleware being used.
-    - **The ROS 2 client library being used.** Reasoning: This helps us narrow down the layer in the stack at which the issue might be.
+  - **The operating system and version.** Reasoning: ROS 2 supports multiple platforms, and some bugs are specific to particular versions of operating systems/compilers.
+  - **The installation method.** Reasoning: Some issues only manifest if ROS 2 has been installed from "fat archives" or from Debians. This can help us determine if the issue is with the packaging process.
+  - **The specific version of ROS 2.** Reasoning: Some bugs may be present in a particular ROS 2 release and later fixed. It is important to know if your installation includes these fixes.
+  - **The DDS/RMW implementation being used;** see `this page <Working-with-multiple-RMW-implementations>` for how to determine which one. Reasoning: Communication issues may be specific to the underlying ROS middleware being used.
+  - **The ROS 2 client library being used.** Reasoning: This helps us narrow down the layer in the stack at which the issue might be.
+    
 - Include a list of steps to reproduce the issue.
 - In case of a bug consider to provide a `short, self contained, correct (compilable), example <http://sscce.org/>`__. Issues are much more likely to be resolved if others can reproduce them easily.
 - Mention troubleshooting steps that have been tried already, including:
-    - Upgrading to the latest version of the code, which may include bug fixes that have not been released yet. Select "building from source" on `this page <Installation#building-from-source>` and follow the instructions to get the "master" branches.
-    - Trying with a different RMW implementation. See `this page <Working-with-multiple-RMW-implementations>` for how to do that.
+  - Upgrading to the latest version of the code, which may include bug fixes that have not been released yet. Select "building from source" on `this page <building-from-source>` and follow the instructions to get the "master" branches.
+  - Trying with a different RMW implementation. See `this page <Working-with-multiple-RMW-implementations>` for how to do that.
 
 Pull requests
 ^^^^^^^^^^^^^
diff --git a/source/Inter-Sphinx-Support.rst b/source/Inter-Sphinx-Support.rst
@@ -15,7 +15,7 @@ To show all Intersphinx links and their targets of an Intersphinx mapping file,
 
 .. code-block:: bash
 
-    python -msphinx.ext.intersphinx url-or-path-to-inv-file
+    python -msphinx.ext.intersphinx "url-or-path-to-inv-file"
 
 This is helpful when searching for the root cause of a broken Intersphinx link in a documentation project.
 
@@ -35,7 +35,7 @@ Examples of intersphinx in action
 
 Links to **source code** can be created as follows:
 
-.. code-block:: bash
+.. note::  
 
     Class :class:`vcstools.VcsClient` implements the :meth:`vcstools.VcsClient.checkout` method.
 
@@ -45,7 +45,7 @@ Class :class:`vcstools.VcsClient` implements the :meth:`vcstools.VcsClient.check
 
 Links to documentation pages:
 
-.. code-block:: bash
+.. note::
 
     Refer to :doc:`vcstools Developer's Guide document<developers_guide>`.
 
@@ -55,7 +55,7 @@ Refer to :doc:`vcstools Developer's Guide document<developers_guide>`.
 
 Links to other pages in this documentation:
 
-.. code-block:: bash
+.. note::
 
     See `the installation page <Installation>`.
 
diff --git a/source/Migration-Guide.rst b/source/Migration-Guide.rst
@@ -312,7 +312,7 @@ There is an equivalent type ``rclcpp::Rate`` object which is basically a drop in
 ROS client library
 ~~~~~~~~~~~~~~~~~~
 
- * `Python Client Library <Migration-Guide-Python.rst>`
+ * `Python Client Library <Migration-Guide-Python>`
  * **NOTE: Others to be written**
 
 Boost
diff --git a/source/OSX-Development-Setup.rst b/source/OSX-Development-Setup.rst
@@ -199,6 +199,7 @@ Source the setup file to set the ``NDDSHOME`` environment variable before buildi
 The setup file and path will depend on your macOS version.
 
 .. code-block:: bash
+
    # macOS 10.12 Sierra
    source /Applications/rti_connext_dds-5.3.1/resource/scripts/rtisetenv_x64Darwin16clang8.0.bash
    # macOS 10.13 High Sierra
diff --git a/source/RQt-Overview-Usage.rst b/source/RQt-Overview-Usage.rst
@@ -23,7 +23,7 @@ Users can create their own plugins for RQt with either ``Python`` or ``C++``.
 `Over 20 plugins <http://wiki.ros.org/rqt/Plugins>`_ were created in ROS 1 and these plugins are currently being ported to ROS 2 (as of Dec 2018, `more info <https://discourse.ros.org/t/rqt-in-ros2/6428>`_).
 
 Installing From Debian
-~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
@@ -68,6 +68,6 @@ Further Reading
 * `RQt for ROS 1 documentation <http://wiki.ros.org/rqt>`_.
 * Brief overview of RQt (from `a Willow Garage intern blog post <http://web.archive.org/web/20130518142837/http://www.willowgarage.com/blog/2012/10/21/ros-gui>`_).
 
-  .. raw::
+  .. raw:: html
 
      <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/CyP9wHu2PpY" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
diff --git a/source/RQt-Port-Plugin-Windows.rst b/source/RQt-Port-Plugin-Windows.rst
@@ -10,9 +10,9 @@ Microsoft pushed an effort to port much of ROS to Windows, their repos are a goo
 They live at the ms-iot organization with branches called init-windows.
 For example: https://github.com/ms-iot/qt_gui_core/tree/init_windows
 
-Here is the ROS 2 port of `qt_gui_core <https://github.com/ros-visualization/qt_gui_core/pull/146/commits/c3a9630de6fed3c46684925e7688b6d4c7b8baf8>`_.
+Here is the ROS 2 port of `qt_gui_core <https://github.com/ros-visualization/qt_gui_core/pull/146/commits/c3a9630de6fed3c46684925e7688b6d4c7b8baf8>`__.
 
-Here is the ROS 2 port of `python_qt_binding <https://github.com/ros-visualization/python_qt_binding/pull/56>`_.
+Here is the ROS 2 port of `python_qt_binding <https://github.com/ros-visualization/python_qt_binding/pull/56>`__.
 
 Considerations for Windows 10
 -----------------------------
@@ -24,14 +24,14 @@ I could not successfully use TinyXML.
 I upgraded to TinyXML-2 where needed.
 It’s a pretty straight forward change.
 
-Checkout `this PR <https://github.com/ros-visualization/qt_gui_core/pull/147>`_ for an example of porting to TinyXML-2.
+Checkout `this PR <https://github.com/ros-visualization/qt_gui_core/pull/147>`__ for an example of porting to TinyXML-2.
 
 Code that uses ``__cplusplus`` and code that requires pluginlib
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In some places, notably in the ROS 2 port of pluginlib, there is use of the ``__cplusplus`` flag.
 Unfortunately on Windows Visual Studio does not set this flag correctly regardless of the C++ standard that is actually being used.
-See `this page <https://docs.microsoft.com/en-us/cpp/build/reference/zc-cplusplus?view=vs-2017>`_ for more information.
+See `this page <https://docs.microsoft.com/en-us/cpp/build/reference/zc-cplusplus?view=vs-2017>`__ for more information.
 
 To set it, you need to add the compile option ``/Zc:__cplusplus``.
 
@@ -55,20 +55,20 @@ On Linux, ``qt_gui_cpp.a`` would be built in:
 But on Windows ``qt_gui_cpp.lib`` is built in
 <ros2_ws>/build/qt_gui_cpp/src/qt_gui_cpp/Release
 
-For compatibility across platforms in this situation, use `CMake generator expressions <https://cmake.org/cmake/help/v3.5/manual/cmake-generator-expressions.7.html>`_.
+For compatibility across platforms in this situation, use `CMake generator expressions <https://cmake.org/cmake/help/v3.5/manual/cmake-generator-expressions.7.html>`__.
 However, when you need a library to link against be sure to use ``$<TARGET_LINKER_FILE:_target>`` instead of ``$<TARGET_FILE:_target>``.
 The latter will find ``.dll`` files, which cannot be linked against on Windows.
-See an `example here <https://github.com/ros-visualization/qt_gui_core/pull/162/files>`_.
+See an `example here <https://github.com/ros-visualization/qt_gui_core/pull/162/files>`__.
 
 Compiler and linker flags
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 In general when porting to Windows, many packages might make use of additional compiler flags.
-You can find the Windows compiler flags on `Microsoft's documentation <https://docs.microsoft.com/en-us/cpp/build/reference/compiler-options-listed-by-category?view=vs-2017>`_.
+You can find the Windows compiler flags on `Microsoft's documentation <https://docs.microsoft.com/en-us/cpp/build/reference/compiler-options-listed-by-category?view=vs-2017>`__.
 The C++ compiler is called ``cl.exe``.
 
-For linker flags see `Microsoft's documentation <https://docs.microsoft.com/en-us/cpp/build/reference/linker-options?view=vs-2017>`_.
+For linker flags see `Microsoft's documentation <https://docs.microsoft.com/en-us/cpp/build/reference/linker-options?view=vs-2017>`__.
 The linker program is called ``link.exe``.
 
 However, CMake actually provides many of these options in variables.
-This `StackOverflow page <https://stackoverflow.com/questions/9298278/cmake-print-out-all-accessible-variables-in-a-script>`_ contains a good example of how to see all the CMake variables available in a script.
+This `StackOverflow page <https://stackoverflow.com/questions/9298278/cmake-print-out-all-accessible-variables-in-a-script>`__ contains a good example of how to see all the CMake variables available in a script.
diff --git a/source/Release-Crystal-Clemmys.rst b/source/Release-Crystal-Clemmys.rst
@@ -146,6 +146,6 @@ Known Issues
 * Cross-vendor communication between rmw_fastrtps_cpp and other implementations is not functioning on Windows (`Issue <https://github.com/ros2/rmw_fastrtps/issues/246>`__)
 * 100% CPU usage in Action Server when cancelling a goal from the client. (`Issue <https://github.com/ros2/examples/issues/221>`__)
 * Action Server can crash when a goal expires. (`Pull Request <https://github.com/ros2/rcl/pull/360>`__)
-* Segfault in `ros2 param get` when a string parameter value contains non-ASCII characters. (`Issue <https://github.com/ros2/ros2cli/issues/176>`__)
+* Segfault in ``ros2 param get`` when a string parameter value contains non-ASCII characters. (`Issue <https://github.com/ros2/ros2cli/issues/176>`__)
 * The latest version of OpenSplice on Windows is not compatible with the available binaries. (`Issue <https://github.com/ros2/build_cop/issues/157>`__)
 
diff --git a/source/Releasing-a-ROS-2-package-with-bloom.rst b/source/Releasing-a-ROS-2-package-with-bloom.rst
@@ -60,7 +60,7 @@ Procedure
 
 Same as in ROS 1: `Following this tutorial <http://wiki.ros.org/bloom/Tutorials/FirstTimeRelease>`__
 
-If porting a ROS 1 package to ROS 2, it's recommended to create a new `-release` repository.
+If porting a ROS 1 package to ROS 2, it's recommended to create a new ``-release`` repository.
 
 Build Status
 ------------
