docs: "Reference" section of the documentation disabled as it crashes Sphinx

2020-09-08 20:02:07 +02:00
1 parent 76b6c2972d
commit 9734fb02e2
@@ -1,80 +0,0 @@
-.. namespace:: units
-
-Concepts
-========
-
-.. note::
-
-    All names defined in this chapter reside in the :any:`units` namespace unless
-    specified otherwise.
-
-.. concept:: template<typename T> PrefixFamily
-
-    A concept matching a prefix family. Satisfied by all types derived from :class:`prefix_family`.
-
-.. concept:: template<typename T> Prefix
-
-    A concept matching a symbol prefix. Satisfied by all instantiations of :class:`prefix`.
-
-.. concept:: template<ratio R> UnitRatio
-
-    Satisfied by all ratio values for which :expr:`R.num > 0` and :expr:`R.den > 0`.
-
-.. concept:: template<typename T> BaseDimension
-
-    A concept matching all base dimensions in the library. Satisfied by all dimension types
-    derived from the instantiation of :class:`base_dimension`.
-
-.. concept:: template<typename T> Exponent
-
-    A concept matching dimension's exponents. Satisfied by all instantiations of :class:`exponent`.
-
-.. concept:: template<typename T> DerivedDimension
-
-    A concept matching all derived dimensions in the library. Satisfied by all dimension
-    types derived from the instantiation of :class:`detail::derived_dimension_base`.
-
-.. concept:: template<typename T> Dimension
-
-    A concept matching all dimensions in the library. Satisfied by all dimension types for
-    which either :expr:`BaseDimension<T>` or :expr:`DerivedDimension<T>` is ``true``.
-
-.. concept:: template<typename T> Unit
-
-    A concept matching all unit types in the library. Satisfied by all unit types derived
-    from the instantiation of :class:`scaled_unit`.
-
-.. concept:: template<typename U, typename D> UnitOf
-
-    A concept matching only units of a specified dimension. Satisfied by all unit types that
-    satisfy :expr:`Unit<U>`, :expr:`Dimension<D>`, and for which :expr:`U::reference` and
-    :expr:`dimension_unit<D>::reference` denote the same unit type.
-
-    :tparam U: Type to verify against concept constraints.
-    :tparam D: Dimension type to use for verification.
-
-.. concept:: template<typename T> Quantity
-
-    A concept matching all quantities in the library. Satisfied by all instantiations of :class:`quantity`.
-
-.. concept:: template<typename T> WrappedQuantity
-
-    A concept matching types that wrap quantity objects. Satisfied by all wrapper types that
-    satisfy :expr:`Quantity<typename T::value_type>` recursively
-    (i.e. :expr:`std::optional<si::length<si::metre>>`).
-
-.. concept:: template<typename T> Scalar
-
-    A concept matching non-Quantity types. Satisfied by types that match
-    :expr:`(!Quantity<T>) && (!WrappedQuantity<T>) && std::regular<T>` and satisfy one of the
-    following:
-
-    - if type :expr:`T` is constructible from ``std::int64_t`` (which is the type that stores
-      the elements of `ratio`), :expr:`T * T` and :expr:`T / T` must be valid,
-    - otherwise, :expr:`T * std::int64_t`, :expr:`std::int64_t * T`, and :expr:`T / std::int64_t`
-      must be valid.
-
-.. concept:: template<typename T> QuantityPoint
-
-    A concept matching all quantity points in the library. Satisfied by all instantiations of
-    :class:`quantity_point`.
@@ -1,7 +0,0 @@
-Customization Points
-====================
-
-.. doxygenvariable:: units::treat_as_floating_point
-
-.. doxygenstruct:: units::quantity_values
-   :members:
@@ -1,4 +0,0 @@
-Functions
-=========
-
-.. doxygenfunction:: units::quantity_cast
@@ -1,4 +0,0 @@
-Metafunctions
-=============
-
-.. doxygentypedef:: dimension_unit
@@ -1,12 +0,0 @@
-Types
-=====
-
-.. toctree::
-    :maxdepth: 1
-
-    types/quantity
-    types/quantity_point
-    types/dimensions
-    types/units
-    types/prefixes
-    types/utilities
@@ -1,11 +0,0 @@
-Dimensions
-==========
-
-.. doxygenstruct:: units::base_dimension
-   :members:
-
-.. doxygenstruct:: units::exponent
-   :members:
-
-.. doxygenstruct:: units::derived_dimension
-   :members:
@@ -1,11 +0,0 @@
-Prefixes
-========
-
-.. doxygenstruct:: units::prefix_family
-   :members:
-
-.. doxygenstruct:: units::no_prefix
-   :members:
-
-.. doxygenstruct:: units::prefix
-   :members:
@@ -1,6 +0,0 @@
-Quantity
-========
-
-.. doxygenclass:: units::quantity
-   :members:
-   :undoc-members:
@@ -1,6 +0,0 @@
-Quantity Point
-==============
-
-.. doxygenclass:: units::quantity_point
-   :members:
-   :undoc-members:
@@ -1,32 +0,0 @@
-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::noble_deduced_unit
-   :members:
-
-.. doxygenstruct:: units::named_deduced_unit
-   :members:
-
-.. doxygenstruct:: units::alias_unit
-   :members:
-
-.. doxygenstruct:: units::prefixed_alias_unit
-   :members:
@@ -1,9 +0,0 @@
-Utilities
-=========
-
-.. toctree::
-    :maxdepth: 1
-
-    utilities/ratio
-    utilities/basic_symbol_text
-    utilities/basic_fixed_string
@@ -1,6 +0,0 @@
-basic_fixed_string
-==================
-
-.. doxygenstruct:: units::basic_fixed_string
-   :members:
-   :undoc-members:
@@ -1,6 +0,0 @@
-basic_symbol_text
-=================
-
-.. doxygenstruct:: units::basic_symbol_text
-   :members:
-   :undoc-members:
@@ -1,6 +0,0 @@
-ratio
-=====
-
-.. doxygenstruct:: units::ratio
-   :members:
-   :undoc-members: