12345qiupeng
/
cartographer_ros
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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 <grupp@magazino.eu>
master
Michael Grupp 2020-10-13 15:00:12 +02:00 committed by GitHub
parent d93769eee3
commit 868d147fb5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/assets_writer.rst
View File

@ -80,8 +80,8 @@ For the last example, if you specify ``points.ply`` in the pipeline configuratio
Configuration Configuration
------------- -------------
The assets writer is modeled as a pipeline of `PointsProcessor`_s. The assets writer is modeled as a pipeline of `PointsProcessor`_ steps.
`PointsBatch`_\ s flow through each processor and they all have the chance to modify the ``PointsBatch`` before passing it on. `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 .. _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 .. _PointsBatch: https://github.com/cartographer-project/cartographer/blob/30f7de1a325d6604c780f2f74d9a345ec369d12d/cartographer/io/points_batch.h

1
docs/source/compilation.rst
View File

@ -76,6 +76,7 @@ If you build cartographer from master. Change/remove the version in the cartogra
Additionally, uninstall the ros abseil-cpp using Additionally, uninstall the ros abseil-cpp using
.. code-block:: bash .. code-block:: bash
sudo apt-get remove ros-${ROS_DISTRO}-abseil-cpp sudo apt-get remove ros-${ROS_DISTRO}-abseil-cpp
Build and install. Build and install.

2
docs/source/demos.rst
View File

@ -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 bag_filename:=${HOME}/Downloads/b3-2016-04-05-15-52-20.bag
Static landmarks Static landmarks
======== ================
.. raw:: html .. raw:: html