From e7ac6bd56306cee44cf9d0e19007137d4eb274ff Mon Sep 17 00:00:00 2001
From: Mateusz Pusz <mateusz.pusz@gmail.com>
Date: Wed, 13 May 2020 15:36:33 +0200
Subject: [PATCH] Reference section of documentation improved

---
 docs/CMakeLists.txt                           | 10 ++++
 docs/index.rst                                |  2 +
 docs/reference/customization_points.rst       |  7 +++
 docs/reference/functions.rst                  | 20 ++++---
 docs/reference/metafunctions.rst              |  4 ++
 docs/reference/types.rst                      | 54 +++----------------
 docs/reference/types/dimensions.rst           | 11 ++++
 docs/reference/types/prefixes.rst             | 11 ++++
 docs/reference/types/quantity.rst             |  6 +++
 docs/reference/types/units.rst                | 26 +++++++++
 docs/reference/types/utilities.rst            |  9 ++++
 .../types/utilities/basic_fixed_string.rst    |  6 +++
 .../types/utilities/basic_symbol_text.rst     |  6 +++
 docs/reference/types/utilities/ratio.rst      |  6 +++
 14 files changed, 123 insertions(+), 55 deletions(-)
 create mode 100644 docs/reference/customization_points.rst
 create mode 100644 docs/reference/metafunctions.rst
 create mode 100644 docs/reference/types/dimensions.rst
 create mode 100644 docs/reference/types/prefixes.rst
 create mode 100644 docs/reference/types/quantity.rst
 create mode 100644 docs/reference/types/units.rst
 create mode 100644 docs/reference/types/utilities.rst
 create mode 100644 docs/reference/types/utilities/basic_fixed_string.rst
 create mode 100644 docs/reference/types/utilities/basic_symbol_text.rst
 create mode 100644 docs/reference/types/utilities/ratio.rst

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index 494ad793..6336d061 100644
--- a/docs/CMakeLists.txt
+++ b/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"
diff --git a/docs/index.rst b/docs/index.rst
index 0922e632..30493fa4 100644
--- a/docs/index.rst
+++ b/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::
diff --git a/docs/reference/customization_points.rst b/docs/reference/customization_points.rst
new file mode 100644
index 00000000..0651f991
--- /dev/null
+++ b/docs/reference/customization_points.rst
@@ -0,0 +1,7 @@
+Customization Points
+====================
+
+.. doxygenvariable:: units::treat_as_floating_point
+
+.. doxygenstruct:: units::quantity_values
+   :members:
diff --git a/docs/reference/functions.rst b/docs/reference/functions.rst
index 93f80690..bb209253 100644
--- a/docs/reference/functions.rst
+++ b/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
diff --git a/docs/reference/metafunctions.rst b/docs/reference/metafunctions.rst
new file mode 100644
index 00000000..2b63b23c
--- /dev/null
+++ b/docs/reference/metafunctions.rst
@@ -0,0 +1,4 @@
+Metafunctions
+=============
+
+.. doxygentypedef:: dimension_unit
diff --git a/docs/reference/types.rst b/docs/reference/types.rst
index 27e38f72..f6fc3164 100644
--- a/docs/reference/types.rst
+++ b/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
-   :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
diff --git a/docs/reference/types/dimensions.rst b/docs/reference/types/dimensions.rst
new file mode 100644
index 00000000..b7bfe170
--- /dev/null
+++ b/docs/reference/types/dimensions.rst
@@ -0,0 +1,11 @@
+Dimensions
+==========
+
+.. doxygenstruct:: units::base_dimension
+   :members:
+
+.. doxygenstruct:: units::exp
+   :members:
+
+.. doxygenstruct:: units::derived_dimension
+   :members:
diff --git a/docs/reference/types/prefixes.rst b/docs/reference/types/prefixes.rst
new file mode 100644
index 00000000..414eda66
--- /dev/null
+++ b/docs/reference/types/prefixes.rst
@@ -0,0 +1,11 @@
+Prefixes
+========
+
+.. doxygenstruct:: units::prefix_family
+   :members:
+
+.. doxygenstruct:: units::no_prefix
+   :members:
+
+.. doxygenstruct:: units::prefix
+   :members:
diff --git a/docs/reference/types/quantity.rst b/docs/reference/types/quantity.rst
new file mode 100644
index 00000000..cabef4e5
--- /dev/null
+++ b/docs/reference/types/quantity.rst
@@ -0,0 +1,6 @@
+Quantity
+========
+
+.. doxygenclass:: units::quantity
+   :members:
+   :undoc-members:
diff --git a/docs/reference/types/units.rst b/docs/reference/types/units.rst
new file mode 100644
index 00000000..65a35484
--- /dev/null
+++ b/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:
diff --git a/docs/reference/types/utilities.rst b/docs/reference/types/utilities.rst
new file mode 100644
index 00000000..b1f5bd10
--- /dev/null
+++ b/docs/reference/types/utilities.rst
@@ -0,0 +1,9 @@
+Utilities
+=========
+
+.. toctree::
+    :maxdepth: 1
+
+    utilities/ratio
+    utilities/basic_symbol_text
+    utilities/basic_fixed_string
diff --git a/docs/reference/types/utilities/basic_fixed_string.rst b/docs/reference/types/utilities/basic_fixed_string.rst
new file mode 100644
index 00000000..f58f7a37
--- /dev/null
+++ b/docs/reference/types/utilities/basic_fixed_string.rst
@@ -0,0 +1,6 @@
+basic_fixed_string
+==================
+
+.. doxygenstruct:: units::basic_fixed_string
+   :members:
+   :undoc-members:
diff --git a/docs/reference/types/utilities/basic_symbol_text.rst b/docs/reference/types/utilities/basic_symbol_text.rst
new file mode 100644
index 00000000..f1138735
--- /dev/null
+++ b/docs/reference/types/utilities/basic_symbol_text.rst
@@ -0,0 +1,6 @@
+basic_symbol_text
+=================
+
+.. doxygenstruct:: units::basic_symbol_text
+   :members:
+   :undoc-members:
diff --git a/docs/reference/types/utilities/ratio.rst b/docs/reference/types/utilities/ratio.rst
new file mode 100644
index 00000000..b4d40c92
--- /dev/null
+++ b/docs/reference/types/utilities/ratio.rst
@@ -0,0 +1,6 @@
+ratio
+=====
+
+.. doxygenstruct:: units::ratio
+   :members:
+   :undoc-members: