docs: Sphinx documentation fixes

Broken links, invalid chapter underlining, invalid code fragments, etc.
This commit is contained in:
Mateusz Pusz
2021-08-29 22:27:13 +02:00
parent 8847cff819
commit 32d0f7c871
8 changed files with 9 additions and 9 deletions

View File

@@ -16,7 +16,7 @@ This example presents the usage of:
.. literalinclude:: ../../../example/glide_computer/include/glide_computer.h .. literalinclude:: ../../../example/glide_computer/include/glide_computer.h
:caption: glide_computer.h :caption: glide_computer.h
:start-at: #include :start-at: #include
:end-before: using namespace units; :end-at: // - flight path exactly on a shortest possible line to destination
:linenos: :linenos:
:lineno-match: :lineno-match:
@@ -37,7 +37,7 @@ For example we have 3 for a quantity of length:
.. literalinclude:: ../../../example/glide_computer/include/glide_computer.h .. literalinclude:: ../../../example/glide_computer/include/glide_computer.h
:caption: glide_computer.h :caption: glide_computer.h
:start-at: using namespace units; :start-after: // - flight path exactly on a shortest possible line to destination
:end-before: // text output :end-before: // text output
:linenos: :linenos:
:lineno-match: :lineno-match:

View File

@@ -1,5 +1,5 @@
Example 7 - Estimating the temperature of the heating liquid I Example 7 - Estimating the temperature of the heating liquid I
============================================================= ==============================================================
Implementation of: https://www.kalmanfilter.net/kalman1d.html#ex7 Implementation of: https://www.kalmanfilter.net/kalman1d.html#ex7

View File

@@ -1,5 +1,5 @@
Example 8 - Estimating the temperature of the heating liquid II Example 8 - Estimating the temperature of the heating liquid II
============================================================== ===============================================================
Implementation of: https://www.kalmanfilter.net/kalman1d.html#ex8 Implementation of: https://www.kalmanfilter.net/kalman1d.html#ex8

View File

@@ -553,7 +553,7 @@ units like CGS.
.. seealso:: .. seealso::
Please refer to :ref:`examples/avg_speed:avg_speed` example for more Please refer to :ref:`examples/basics/avg_speed:avg_speed` example for more
information on different kinds of interfaces supported by the library. information on different kinds of interfaces supported by the library.

View File

@@ -73,5 +73,5 @@ Now ``x`` coordinates can be constructed::
.. seealso:: .. seealso::
Please refer to :ref:`examples/glide_computer:glide_computer` example for more Please refer to :ref:`examples/basics/glide_computer:glide_computer` example for more
information on the quantity kinds usage. information on the quantity kinds usage.

View File

@@ -305,4 +305,4 @@ representation types with::
For more examples of custom representation types usage please refer to the For more examples of custom representation types usage please refer to the
:ref:`use_cases/linear_algebra:Linear Algebra vs. Quantities` chapter and the :ref:`use_cases/linear_algebra:Linear Algebra vs. Quantities` chapter and the
:ref:`examples/measurement:measurement` example. :ref:`examples/custom_representation/measurement:measurement` example.

View File

@@ -85,4 +85,4 @@ output:
.. seealso:: .. seealso::
For more examples of Linear Algebra definition and operations please refer to For more examples of Linear Algebra definition and operations please refer to
the :ref:`examples/linear_algebra:linear_algebra` example. the :ref:`examples/custom_representation/linear_algebra:linear_algebra` example.

View File

@@ -87,7 +87,7 @@ following::
.. seealso:: .. seealso::
Another good example of unknown dimension usage can be found in the Another good example of unknown dimension usage can be found in the
:ref:`examples/box_example:box_example`:: :ref:`examples/basics/box_example:box_example`::
std::cout << "float rise rate = " << box.fill_level(measured_mass) / fill_time << '\n'; std::cout << "float rise rate = " << box.fill_level(measured_mass) / fill_time << '\n';