Remaining examples added to documentation

This commit is contained in:
Mateusz Pusz
2020-05-13 13:11:07 +02:00
parent df6a0da9d3
commit 64a8b32b8f
8 changed files with 59 additions and 2 deletions

View File

@@ -75,9 +75,14 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
"${CMAKE_CURRENT_SOURCE_DIR}/examples.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/avg_speed.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/box_example.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/capacitor_time_curve.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/clcpp_response.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/conversion_factor.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/hello_units.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/kalman_filter-alpha_beta_filter_example2.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/linear_algebra.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/measurement.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/examples/total_energy.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/faq.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/framework.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/framework/basic_concepts.rst"

View File

@@ -2,10 +2,17 @@ Examples
========
.. toctree::
:maxdepth: 2
:maxdepth: 1
examples/hello_units
examples/avg_speed
examples/box_example
examples/unknown_dimension
examples/measurement
examples/linear_algebra
examples/box_example
examples/capacitor_time_curve
examples/clcpp_response
examples/conversion_factor
examples/kalman_filter-alpha_beta_filter_example2
examples/total_energy

View File

@@ -0,0 +1,7 @@
capacitor_time_curve
====================
.. literalinclude:: ../../example/capacitor_time_curve.cpp
:caption: capacitor_time_curve.cpp
:start-at: #include
:linenos:

View File

@@ -0,0 +1,7 @@
clcpp_response
==============
.. literalinclude:: ../../example/clcpp_response.cpp
:caption: clcpp_response.cpp
:start-at: #include
:linenos:

View File

@@ -0,0 +1,7 @@
conversion_factor
=================
.. literalinclude:: ../../example/conversion_factor.cpp
:caption: conversion_factor.cpp
:start-at: #include
:linenos:

View File

@@ -0,0 +1,10 @@
kalman_filter-alpha_beta_filter_example2
========================================
This example is based on the 1d aircraft α-β filter example 2 from the
`Kalman Filter <https://www.kalmanfilter.net/alphabeta.html#ex2>`_ tutorial.
.. literalinclude:: ../../example/kalman_filter-alpha_beta_filter_example2.cpp
:caption: kalman_filter-alpha_beta_filter_example2.cpp
:start-at: #include
:linenos:

View File

@@ -0,0 +1,7 @@
total_energy
============
.. literalinclude:: ../../example/total_energy.cpp
:caption: total_energy.cpp
:start-at: #include
:linenos:

View File

@@ -0,0 +1,7 @@
unknown_dimension
=================
.. literalinclude:: ../../example/unknown_dimension.cpp
:caption: unknown_dimension.cpp
:start-at: #include
:linenos: