mpusz/mp-units
1
0
Fork 1
mirror of https://github.com/mpusz/mp-units.git synced 2025-08-05 05:04:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: generic quantities documentation added

Browse Source
This commit is contained in:
Mateusz Pusz
2020-09-14 08:43:18 +02:00
parent 63d288636f
commit 3fae2b537e
6 changed files with 43 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/CMakeLists.txt
View File

@@ -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/information.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/data/prefixes.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.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/natural.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/natural.rst"

5
docs/reference/systems.rst
View File

@@ -1,6 +1,11 @@
Systems Systems
======= =======
.. toctree::
:maxdepth: 2
systems/generic
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

9
docs/reference/systems/generic.rst Normal file
View File

@@ -0,0 +1,9 @@
Generic
=======
.. toctree::
:maxdepth: 2
generic/unknown
generic/dimensionless
generic/angle

8
docs/reference/systems/generic/angle.rst Normal file
View File

@@ -0,0 +1,8 @@
Angle
=====
.. doxygenstruct:: units::radian
.. doxygenstruct:: units::dim_angle
.. doxygentypedef:: units::angle

10
docs/reference/systems/generic/dimensionless.rst Normal file
View File

@@ -0,0 +1,10 @@
Dimensionless
=============
.. doxygenstruct:: units::one
.. doxygenstruct:: units::percent
.. doxygenstruct:: units::dim_one
.. doxygentypedef:: units::dimensionless

6
docs/reference/systems/generic/unknown.rst Normal file
View File

@@ -0,0 +1,6 @@
Unknown
=======
.. doxygenstruct:: units::unknown_coherent_unit
.. doxygenstruct:: units::unknown_dimension