mirror of
https://github.com/mpusz/mp-units.git
synced 2025-08-05 21:24:27 +02:00
Reference section of documentation refactored + random added
This commit is contained in:
@@ -104,10 +104,24 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
|
|||||||
"${CMAKE_CURRENT_SOURCE_DIR}/introduction.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/introduction.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/quick_start.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/quick_start.rst"
|
||||||
|
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/concepts.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/customization_points.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/concepts.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/functions.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/customization_points.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/metafunctions.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/functions.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/metafunctions.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/dimensions.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/prefixes.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/quantity.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/units.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities/basic_fixed_string.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities/basic_symbol_text.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities/ratio.rst"
|
||||||
|
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/math.rst"
|
||||||
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/random.rst"
|
||||||
|
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems.rst"
|
||||||
|
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/data.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/data.rst"
|
||||||
@@ -199,16 +213,6 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
|
|||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/us.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/us.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/us/length.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/reference/systems/physical/us/length.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.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/custom_representation_types.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/custom_representation_types.rst"
|
||||||
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/extensions.rst"
|
"${CMAKE_CURRENT_SOURCE_DIR}/use_cases/extensions.rst"
|
||||||
|
@@ -32,15 +32,13 @@ with a permissive `MIT license <https://github.com/mpusz/units/blob/master/LICEN
|
|||||||
faq
|
faq
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 2
|
||||||
:caption: Reference:
|
:caption: Reference:
|
||||||
|
|
||||||
reference/concepts
|
reference/core
|
||||||
reference/types
|
|
||||||
reference/functions
|
|
||||||
reference/metafunctions
|
|
||||||
reference/customization_points
|
|
||||||
reference/systems
|
reference/systems
|
||||||
|
reference/math
|
||||||
|
reference/random
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
11
docs/reference/core.rst
Normal file
11
docs/reference/core.rst
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
Core Library
|
||||||
|
============
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
core/concepts
|
||||||
|
core/types
|
||||||
|
core/functions
|
||||||
|
core/metafunctions
|
||||||
|
core/customization_points
|
4
docs/reference/core/functions.rst
Normal file
4
docs/reference/core/functions.rst
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
Functions
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. doxygenfunction:: units::quantity_cast
|
@@ -1,14 +1,5 @@
|
|||||||
Functions
|
|
||||||
=========
|
|
||||||
|
|
||||||
Casting and Converions
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. doxygenfunction:: units::quantity_cast
|
|
||||||
|
|
||||||
|
|
||||||
Math
|
Math
|
||||||
----
|
====
|
||||||
|
|
||||||
.. doxygenfunction:: units::pow
|
.. doxygenfunction:: units::pow
|
||||||
|
|
40
docs/reference/random.rst
Normal file
40
docs/reference/random.rst
Normal file
@@ -0,0 +1,40 @@
|
|||||||
|
Random
|
||||||
|
======
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::uniform_int_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::uniform_real_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::binomial_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::negative_binomial_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::geometric_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::poisson_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::exponential_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::gamma_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::weibull_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::extreme_value_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::normal_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::lognormal_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::chi_squared_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::cauchy_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::fisher_f_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::student_t_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::discrete_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::piecewise_constant_distribution
|
||||||
|
|
||||||
|
.. doxygenstruct:: units::piecewise_linear_distribution
|
Reference in New Issue
Block a user