Sphinx-based documentation added

This commit is contained in:
Mateusz Pusz
2020-03-09 18:55:41 +01:00
parent af6358fbdb
commit b65328d575
88 changed files with 6476 additions and 154 deletions

View File

@@ -0,0 +1,22 @@
.. namespace:: units
Basic Concepts
==============
The most important concepts in the library are `Unit`, `Dimension`, and
`Quantity`:
.. image:: /_static/img/design.png
:align: center
`Unit` is a basic building block of the library. Every dimension works with
a concrete hierarchy of units. Such hierarchy defines a reference unit and
often a few scaled versions of it.
`Dimension` concept matches a dimension of either a base or derived quantity.
`base_dimension` is instantiated with a unique symbol identifier and a base
unit. `derived_dimension` is a list of exponents of either base or other
derived dimensions.
`Quantity` is a concrete amount of a unit for a specified dimension with a
specific representation.