From 64a8b32b8f0d04c115f820024a1851d97305c780 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Wed, 13 May 2020 13:11:07 +0200 Subject: [PATCH] Remaining examples added to documentation --- docs/CMakeLists.txt | 5 +++++ docs/examples.rst | 11 +++++++++-- docs/examples/capacitor_time_curve.rst | 7 +++++++ docs/examples/clcpp_response.rst | 7 +++++++ docs/examples/conversion_factor.rst | 7 +++++++ .../kalman_filter-alpha_beta_filter_example2.rst | 10 ++++++++++ docs/examples/total_energy.rst | 7 +++++++ docs/examples/unknown_dimension.rst | 7 +++++++ 8 files changed, 59 insertions(+), 2 deletions(-) create mode 100644 docs/examples/capacitor_time_curve.rst create mode 100644 docs/examples/clcpp_response.rst create mode 100644 docs/examples/conversion_factor.rst create mode 100644 docs/examples/kalman_filter-alpha_beta_filter_example2.rst create mode 100644 docs/examples/total_energy.rst create mode 100644 docs/examples/unknown_dimension.rst diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index c51ffe6f..494ad793 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -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" diff --git a/docs/examples.rst b/docs/examples.rst index f9d1b56b..0faff276 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -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 diff --git a/docs/examples/capacitor_time_curve.rst b/docs/examples/capacitor_time_curve.rst new file mode 100644 index 00000000..779865e3 --- /dev/null +++ b/docs/examples/capacitor_time_curve.rst @@ -0,0 +1,7 @@ +capacitor_time_curve +==================== + +.. literalinclude:: ../../example/capacitor_time_curve.cpp + :caption: capacitor_time_curve.cpp + :start-at: #include + :linenos: diff --git a/docs/examples/clcpp_response.rst b/docs/examples/clcpp_response.rst new file mode 100644 index 00000000..4419b84a --- /dev/null +++ b/docs/examples/clcpp_response.rst @@ -0,0 +1,7 @@ +clcpp_response +============== + +.. literalinclude:: ../../example/clcpp_response.cpp + :caption: clcpp_response.cpp + :start-at: #include + :linenos: diff --git a/docs/examples/conversion_factor.rst b/docs/examples/conversion_factor.rst new file mode 100644 index 00000000..21bbefc5 --- /dev/null +++ b/docs/examples/conversion_factor.rst @@ -0,0 +1,7 @@ +conversion_factor +================= + +.. literalinclude:: ../../example/conversion_factor.cpp + :caption: conversion_factor.cpp + :start-at: #include + :linenos: diff --git a/docs/examples/kalman_filter-alpha_beta_filter_example2.rst b/docs/examples/kalman_filter-alpha_beta_filter_example2.rst new file mode 100644 index 00000000..9db65572 --- /dev/null +++ b/docs/examples/kalman_filter-alpha_beta_filter_example2.rst @@ -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 `_ tutorial. + +.. literalinclude:: ../../example/kalman_filter-alpha_beta_filter_example2.cpp + :caption: kalman_filter-alpha_beta_filter_example2.cpp + :start-at: #include + :linenos: diff --git a/docs/examples/total_energy.rst b/docs/examples/total_energy.rst new file mode 100644 index 00000000..ba31816f --- /dev/null +++ b/docs/examples/total_energy.rst @@ -0,0 +1,7 @@ +total_energy +============ + +.. literalinclude:: ../../example/total_energy.cpp + :caption: total_energy.cpp + :start-at: #include + :linenos: diff --git a/docs/examples/unknown_dimension.rst b/docs/examples/unknown_dimension.rst new file mode 100644 index 00000000..d0241439 --- /dev/null +++ b/docs/examples/unknown_dimension.rst @@ -0,0 +1,7 @@ +unknown_dimension +================= + +.. literalinclude:: ../../example/unknown_dimension.cpp + :caption: unknown_dimension.cpp + :start-at: #include + :linenos: