From 3fae2b537ebd2e05942e98544b75667d6e91ed31 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Mon, 14 Sep 2020 08:43:18 +0200 Subject: [PATCH] docs: generic quantities documentation added --- docs/CMakeLists.txt | 5 +++++ docs/reference/systems.rst | 5 +++++ docs/reference/systems/generic.rst | 9 +++++++++ docs/reference/systems/generic/angle.rst | 8 ++++++++ docs/reference/systems/generic/dimensionless.rst | 10 ++++++++++ docs/reference/systems/generic/unknown.rst | 6 ++++++ 6 files changed, 43 insertions(+) create mode 100644 docs/reference/systems/generic.rst create mode 100644 docs/reference/systems/generic/angle.rst create mode 100644 docs/reference/systems/generic/dimensionless.rst create mode 100644 docs/reference/systems/generic/unknown.rst diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 20830149..a39e37e5 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -143,6 +143,11 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}" "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/data/information.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/data/prefixes.rst" + "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/generic.rst" + "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/generic/angle.rst" + "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/generic/dimensionless.rst" + "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/generic/unknown.rst" + "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/natural.rst" diff --git a/docs/reference/systems.rst b/docs/reference/systems.rst index 6391daef..aa5ce92b 100644 --- a/docs/reference/systems.rst +++ b/docs/reference/systems.rst @@ -1,6 +1,11 @@ Systems ======= +.. toctree:: + :maxdepth: 2 + + systems/generic + .. toctree:: :maxdepth: 2 diff --git a/docs/reference/systems/generic.rst b/docs/reference/systems/generic.rst new file mode 100644 index 00000000..1759a546 --- /dev/null +++ b/docs/reference/systems/generic.rst @@ -0,0 +1,9 @@ +Generic +======= + +.. toctree:: + :maxdepth: 2 + + generic/unknown + generic/dimensionless + generic/angle diff --git a/docs/reference/systems/generic/angle.rst b/docs/reference/systems/generic/angle.rst new file mode 100644 index 00000000..bf6eeab0 --- /dev/null +++ b/docs/reference/systems/generic/angle.rst @@ -0,0 +1,8 @@ +Angle +===== + +.. doxygenstruct:: units::radian + +.. doxygenstruct:: units::dim_angle + +.. doxygentypedef:: units::angle diff --git a/docs/reference/systems/generic/dimensionless.rst b/docs/reference/systems/generic/dimensionless.rst new file mode 100644 index 00000000..4bd1b829 --- /dev/null +++ b/docs/reference/systems/generic/dimensionless.rst @@ -0,0 +1,10 @@ +Dimensionless +============= + +.. doxygenstruct:: units::one + +.. doxygenstruct:: units::percent + +.. doxygenstruct:: units::dim_one + +.. doxygentypedef:: units::dimensionless diff --git a/docs/reference/systems/generic/unknown.rst b/docs/reference/systems/generic/unknown.rst new file mode 100644 index 00000000..0f563f71 --- /dev/null +++ b/docs/reference/systems/generic/unknown.rst @@ -0,0 +1,6 @@ +Unknown +======= + +.. doxygenstruct:: units::unknown_coherent_unit + +.. doxygenstruct:: units::unknown_dimension