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

Reference section of documentation improved

Browse Source
This commit is contained in:
Mateusz Pusz
2020-05-13 15:36:33 +02:00
parent e58c8054bc
commit e7ac6bd563
14 changed files with 123 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/CMakeLists.txt
View File

@@ -98,9 +98,19 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
"${CMAKE_CURRENT_SOURCE_DIR}/introduction.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/quick_start.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/concepts.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/customization_points.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/functions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/metafunctions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/dimensions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/prefixes.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/quantity.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/units.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/utilities.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/utilities/basic_fixed_string.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/utilities/basic_symbol_text.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/types/utilities/ratio.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/custom_representation_types.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/extensions.rst"

2
docs/index.rst
View File

@@ -38,6 +38,8 @@ with a permissive `MIT license <https://github.com/mpusz/units/blob/master/LICEN
reference/concepts
reference/types
reference/functions
reference/metafunctions
reference/customization_points
reference/systems
.. toctree::

7
docs/reference/customization_points.rst Normal file
View File

@@ -0,0 +1,7 @@
Customization Points
====================
.. doxygenvariable:: units::treat_as_floating_point
.. doxygenstruct:: units::quantity_values
:members:

20
docs/reference/functions.rst
View File

@@ -1,15 +1,19 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Functions
=========
.. doxygenfunction:: quantity_cast
Casting and Converions
----------------------
.. doxygenfunction:: units::quantity_cast
Math
----
Metafunctions
=============
.. doxygenfunction:: units::pow
.. doxygentypedef:: dimension_unit
.. doxygenfunction:: units::sqrt
.. doxygenfunction:: units::abs
.. doxygenfunction:: units::epsilon

4
docs/reference/metafunctions.rst Normal file
View File

@@ -0,0 +1,4 @@
Metafunctions
=============
.. doxygentypedef:: dimension_unit

54
docs/reference/types.rst
View File

@@ -1,51 +1,11 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Types
=====
Quantity
--------
.. toctree::
:maxdepth: 1
.. doxygenclass:: units::quantity
:members:
..
:undoc-members:
Dimension
---------
.. doxygenstruct:: units::base_dimension
:members:
.. doxygenstruct:: units::derived_dimension
:members:
Unit
----
.. doxygenstruct:: units::scaled_unit
:members:
.. doxygenstruct:: units::unit
:members:
.. doxygenstruct:: units::named_unit
:members:
.. doxygenstruct:: units::named_scaled_unit
:members:
.. doxygenstruct:: units::prefixed_unit
:members:
.. doxygenstruct:: units::deduced_unit
:members:
Ratio
-----
.. doxygenstruct:: units::ratio
:members:
types/quantity
types/dimensions
types/units
types/prefixes
types/utilities

11
docs/reference/types/dimensions.rst Normal file
View File

@@ -0,0 +1,11 @@
Dimensions
==========
.. doxygenstruct:: units::base_dimension
:members:
.. doxygenstruct:: units::exp
:members:
.. doxygenstruct:: units::derived_dimension
:members:

11
docs/reference/types/prefixes.rst Normal file
View File

@@ -0,0 +1,11 @@
Prefixes
========
.. doxygenstruct:: units::prefix_family
:members:
.. doxygenstruct:: units::no_prefix
:members:
.. doxygenstruct:: units::prefix
:members:

6
docs/reference/types/quantity.rst Normal file
View File

@@ -0,0 +1,6 @@
Quantity
========
.. doxygenclass:: units::quantity
:members:
:undoc-members:

26
docs/reference/types/units.rst Normal file
View File

@@ -0,0 +1,26 @@
Units
=====
.. doxygenstruct:: units::scaled_unit
:members:
.. doxygenstruct:: units::unit
:members:
.. doxygenstruct:: units::named_unit
:members:
.. doxygenstruct:: units::named_scaled_unit
:members:
.. doxygenstruct:: units::prefixed_unit
:members:
.. doxygenstruct:: units::deduced_unit
:members:
.. doxygenstruct:: units::alias_unit
:members:
.. doxygenstruct:: units::prefixed_alias_unit
:members:

9
docs/reference/types/utilities.rst Normal file
View File

@@ -0,0 +1,9 @@
Utilities
=========
.. toctree::
:maxdepth: 1
utilities/ratio
utilities/basic_symbol_text
utilities/basic_fixed_string

6
docs/reference/types/utilities/basic_fixed_string.rst Normal file
View File

@@ -0,0 +1,6 @@
basic_fixed_string
==================
.. doxygenstruct:: units::basic_fixed_string
:members:
:undoc-members:

6
docs/reference/types/utilities/basic_symbol_text.rst Normal file
View File

@@ -0,0 +1,6 @@
basic_symbol_text
=================
.. doxygenstruct:: units::basic_symbol_text
:members:
:undoc-members:

6
docs/reference/types/utilities/ratio.rst Normal file
View File

@@ -0,0 +1,6 @@
ratio
=====
.. doxygenstruct:: units::ratio
:members:
:undoc-members: