From 868d147fb5356c441142b0dfa1a87d1b1008d5e1 Mon Sep 17 00:00:00 2001 From: Michael Grupp Date: Tue, 13 Oct 2020 15:00:12 +0200 Subject: [PATCH] Fix Sphinx documentation errors & warnings. (#1523) Fixes broken links, code blocks and other things that `sphinx-build docs/source docs/out -E` complained about. Signed-off-by: Michael Grupp --- docs/source/assets_writer.rst | 4 ++-- docs/source/compilation.rst | 1 + docs/source/demos.rst | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/assets_writer.rst b/docs/source/assets_writer.rst index 1cf223c..de936d6 100644 --- a/docs/source/assets_writer.rst +++ b/docs/source/assets_writer.rst @@ -80,8 +80,8 @@ For the last example, if you specify ``points.ply`` in the pipeline configuratio Configuration ------------- -The assets writer is modeled as a pipeline of `PointsProcessor`_s. -`PointsBatch`_\ s flow through each processor and they all have the chance to modify the ``PointsBatch`` before passing it on. +The assets writer is modeled as a pipeline of `PointsProcessor`_ steps. +`PointsBatch`_ data flows through each processor and they all have the chance to modify the ``PointsBatch`` before passing it on. .. _PointsProcessor: https://github.com/cartographer-project/cartographer/blob/30f7de1a325d6604c780f2f74d9a345ec369d12d/cartographer/io/points_processor.h .. _PointsBatch: https://github.com/cartographer-project/cartographer/blob/30f7de1a325d6604c780f2f74d9a345ec369d12d/cartographer/io/points_batch.h diff --git a/docs/source/compilation.rst b/docs/source/compilation.rst index 4607db2..0d922a9 100644 --- a/docs/source/compilation.rst +++ b/docs/source/compilation.rst @@ -76,6 +76,7 @@ If you build cartographer from master. Change/remove the version in the cartogra Additionally, uninstall the ros abseil-cpp using .. code-block:: bash + sudo apt-get remove ros-${ROS_DISTRO}-abseil-cpp Build and install. diff --git a/docs/source/demos.rst b/docs/source/demos.rst index 4e2e19e..dac214f 100644 --- a/docs/source/demos.rst +++ b/docs/source/demos.rst @@ -81,7 +81,7 @@ Generate the map (wait until cartographer_offline_node finishes) and then run pu bag_filename:=${HOME}/Downloads/b3-2016-04-05-15-52-20.bag Static landmarks -======== +================ .. raw:: html