Reference section of documentation improved

docs/CMakeLists.txt

@@ -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"

docs/index.rst

@@ -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::

docs/reference/customization_points.rst

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

docs/reference/functions.rst

@@ -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

docs/reference/metafunctions.rst

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

docs/reference/types.rst

@@ -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
+    types/quantity
-   :members:
+    types/dimensions
-
+    types/units
-.. 
+    types/prefixes
-   :undoc-members:
+    types/utilities
-
-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:

docs/reference/types/dimensions.rst

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

docs/reference/types/prefixes.rst

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

docs/reference/types/quantity.rst

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

docs/reference/types/units.rst

@@ -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:

docs/reference/types/utilities.rst

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

docs/reference/types/utilities/basic_fixed_string.rst

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

docs/reference/types/utilities/basic_symbol_text.rst

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

docs/reference/types/utilities/ratio.rst

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