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

This commit is contained in:
Mateusz Pusz
2020-09-08 20:02:07 +02:00
parent 76b6c2972d
commit 9734fb02e2
109 changed files with 112 additions and 110 deletions
-11
View File
@@ -1,11 +0,0 @@
Core Library
============
.. toctree::
:maxdepth: 1
core/concepts
core/types
core/functions
core/metafunctions
core/customization_points
-80
View File
@@ -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:
-4
View File
@@ -1,4 +0,0 @@
Functions
=========
.. doxygenfunction:: units::quantity_cast
-4
View File
@@ -1,4 +0,0 @@
Metafunctions
=============
.. doxygentypedef:: dimension_unit
-12
View File
@@ -1,12 +0,0 @@
Types
=====
.. toctree::
:maxdepth: 1
types/quantity
types/quantity_point
types/dimensions
types/units
types/prefixes
types/utilities
-11
View File
@@ -1,11 +0,0 @@
Dimensions
==========
.. doxygenstruct:: units::base_dimension
:members:
.. doxygenstruct:: units::exponent
:members:
.. doxygenstruct:: units::derived_dimension
:members:
-11
View File
@@ -1,11 +0,0 @@
Prefixes
========
.. doxygenstruct:: units::prefix_family
:members:
.. doxygenstruct:: units::no_prefix
:members:
.. doxygenstruct:: units::prefix
:members:
-6
View File
@@ -1,6 +0,0 @@
Quantity
========
.. doxygenclass:: units::quantity
:members:
:undoc-members:
@@ -1,6 +0,0 @@
Quantity Point
==============
.. doxygenclass:: units::quantity_point
:members:
:undoc-members:
-32
View File
@@ -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:
-9
View File
@@ -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:
-10
View File
@@ -1,10 +0,0 @@
Math
====
.. doxygenfunction:: units::pow
.. doxygenfunction:: units::sqrt
.. doxygenfunction:: units::abs
.. doxygenfunction:: units::epsilon
-40
View File
@@ -1,40 +0,0 @@
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
-12
View File
@@ -1,12 +0,0 @@
Systems
=======
.. toctree::
:maxdepth: 2
systems/physical
.. toctree::
:maxdepth: 1
systems/data
-9
View File
@@ -1,9 +0,0 @@
Data
====
.. toctree::
:maxdepth: 2
data/prefixes
data/information
data/bitrate
-4
View File
@@ -1,4 +0,0 @@
Bitrate
=======
.. doxygenfile:: data/bitrate.h
@@ -1,4 +0,0 @@
Information
===========
.. doxygenfile:: data/information.h
-4
View File
@@ -1,4 +0,0 @@
Prefixes
========
.. doxygenfile:: data/prefixes.h
-16
View File
@@ -1,16 +0,0 @@
Physical
========
.. toctree::
:maxdepth: 2
physical/dimensions_and_concepts
physical/si
physical/cgs
physical/international
physical/us
physical/imperial
physical/fps
physical/iau
physical/typographic
physical/natural
-16
View File
@@ -1,16 +0,0 @@
CGS
===
.. toctree::
:maxdepth: 2
cgs/acceleration
cgs/area
cgs/energy
cgs/force
cgs/length
cgs/mass
cgs/power
cgs/pressure
cgs/speed
cgs/time
@@ -1,4 +0,0 @@
Acceleration
============
.. doxygenfile:: cgs/acceleration.h
@@ -1,4 +0,0 @@
Area
====
.. doxygenfile:: cgs/area.h
@@ -1,4 +0,0 @@
Energy
======
.. doxygenfile:: cgs/energy.h
@@ -1,4 +0,0 @@
Force
=====
.. doxygenfile:: cgs/force.h
@@ -1,4 +0,0 @@
Length
======
.. doxygenfile:: cgs/length.h
@@ -1,4 +0,0 @@
Mass
====
.. doxygenfile:: cgs/mass.h
@@ -1,4 +0,0 @@
Power
=====
.. doxygenfile:: cgs/power.h
@@ -1,4 +0,0 @@
Pressure
========
.. doxygenfile:: cgs/pressure.h
@@ -1,4 +0,0 @@
Speed
=====
.. doxygenfile:: cgs/speed.h
@@ -1,4 +0,0 @@
Time
====
.. doxygenfile:: cgs/time.h
@@ -1,4 +0,0 @@
Dimensions and Concepts
=======================
.. doxygenfile:: dimensions.h
-18
View File
@@ -1,18 +0,0 @@
FPS
===
.. toctree::
:maxdepth: 2
fps/acceleration
fps/area
fps/density
fps/energy
fps/force
fps/length
fps/mass
fps/power
fps/pressure
fps/speed
fps/time
fps/volume
@@ -1,4 +0,0 @@
Acceleration
============
.. doxygenfile:: fps/acceleration.h
@@ -1,4 +0,0 @@
Area
====
.. doxygenfile:: fps/area.h
@@ -1,4 +0,0 @@
Density
=======
.. doxygenfile:: fps/density.h
@@ -1,4 +0,0 @@
Energy
======
.. doxygenfile:: fps/energy.h
@@ -1,4 +0,0 @@
Force
=====
.. doxygenfile:: fps/force.h
@@ -1,4 +0,0 @@
Length
======
.. doxygenfile:: fps/length.h
@@ -1,4 +0,0 @@
Mass
====
.. doxygenfile:: fps/mass.h
@@ -1,4 +0,0 @@
Power
=====
.. doxygenfile:: fps/power.h
@@ -1,4 +0,0 @@
Pressure
========
.. doxygenfile:: fps/pressure.h
@@ -1,4 +0,0 @@
Speed
=====
.. doxygenfile:: fps/speed.h
@@ -1,4 +0,0 @@
Time
====
.. doxygenfile:: fps/time.h
@@ -1,4 +0,0 @@
Volume
======
.. doxygenfile:: fps/volume.h
-7
View File
@@ -1,7 +0,0 @@
IAU
===
.. toctree::
:maxdepth: 2
iau/length
@@ -1,4 +0,0 @@
Length
======
.. doxygenfile:: iau/length.h
@@ -1,7 +0,0 @@
Imperial
========
.. toctree::
:maxdepth: 2
imperial/length
@@ -1,4 +0,0 @@
Length
======
.. doxygenfile:: imperial/length.h
@@ -1,10 +0,0 @@
International
=============
.. toctree::
:maxdepth: 2
international/area
international/length
international/speed
international/volume
@@ -1,4 +0,0 @@
Area
====
.. doxygenfile:: international/area.h
@@ -1,4 +0,0 @@
Length
======
.. doxygenfile:: international/length.h
@@ -1,4 +0,0 @@
Speed
=====
.. doxygenfile:: speed/length.h
@@ -1,4 +0,0 @@
Volume
======
.. doxygenfile:: international/volume.h
@@ -1,9 +0,0 @@
Natural
=======
.. toctree::
:maxdepth: 2
natural/dimensions
natural/units
natural/constants
@@ -1,4 +0,0 @@
Constants
=========
.. doxygenfile:: natural/constants.h
@@ -1,4 +0,0 @@
Dimensions
==========
.. doxygenfile:: natural/dimensions.h
@@ -1,4 +0,0 @@
Units
=====
.. doxygenfile:: natural/units.h
-48
View File
@@ -1,48 +0,0 @@
SI
==
.. toctree::
:maxdepth: 2
si/prefixes
si/constants
si/absorbed_dose
si/acceleration
si/area
si/capacitance
si/catalytic_activity
si/charge_density
si/concentration
si/conductance
si/current_density
si/current
si/density
si/dynamic_viscosity
si/electric_charge
si/electric_field_strength
si/energy
si/force
si/frequency
si/heat_capacity
si/inductance
si/length
si/luminance
si/luminous_intensity
si/magnetic_flux
si/magnetic_induction
si/mass
si/molar_energy
si/momentum
si/permeability
si/permittivity
si/power
si/pressure
si/resistance
si/speed
si/substance
si/surface_tension
si/temperature
si/thermal_conductivity
si/time
si/voltage
si/volume
@@ -1,4 +0,0 @@
Absorbed Dose
=============
.. doxygenfile:: si/absorbed_dose.h
@@ -1,4 +0,0 @@
Acceleration
============
.. doxygenfile:: si/acceleration.h
@@ -1,4 +0,0 @@
Area
====
.. doxygenfile:: si/area.h
@@ -1,4 +0,0 @@
Capacitance
===========
.. doxygenfile:: si/capacitance.h
@@ -1,4 +0,0 @@
Catalytic Activity
==================
.. doxygenfile:: si/catalytic_activity.h
@@ -1,4 +0,0 @@
Charge Density
==============
.. doxygenfile:: si/charge_density.h
@@ -1,4 +0,0 @@
Concentration
=============
.. doxygenfile:: si/conductance.h
@@ -1,4 +0,0 @@
Conductance
===========
.. doxygenfile:: si/conductance.h
@@ -1,4 +0,0 @@
Constants
=========
.. doxygenfile:: si/constants.h
@@ -1,4 +0,0 @@
Current
=======
.. doxygenfile:: si/current.h
@@ -1,4 +0,0 @@
Current density
===============
.. doxygenfile:: si/current_density.h
@@ -1,4 +0,0 @@
Density
=======
.. doxygenfile:: si/density.h
@@ -1,4 +0,0 @@
Dynamic Viscosity
=================
.. doxygenfile:: si/dynamic_viscosity.h
@@ -1,4 +0,0 @@
Electric Charge
===============
.. doxygenfile:: si/electric_charge.h
@@ -1,4 +0,0 @@
Electric Field Strength
=======================
.. doxygenfile:: si/electric_field_strength.h
@@ -1,4 +0,0 @@
Energy
======
.. doxygenfile:: si/energy.h
@@ -1,4 +0,0 @@
Force
=====
.. doxygenfile:: si/force.h
@@ -1,4 +0,0 @@
Frequency
=========
.. doxygenfile:: si/frequency.h
@@ -1,4 +0,0 @@
Heat Capacity
=============
.. doxygenfile:: si/heat_capacity.h
@@ -1,4 +0,0 @@
Inductance
==========
.. doxygenfile:: si/inductance.h
@@ -1,4 +0,0 @@
Length
======
.. doxygenfile:: si/length.h
@@ -1,4 +0,0 @@
Luminance
=========
.. doxygenfile:: si/luminance.h
@@ -1,4 +0,0 @@
Luminous Intensity
==================
.. doxygenfile:: si/luminous_intensity.h
@@ -1,4 +0,0 @@
Magnetic Flux
=============
.. doxygenfile:: si/magnetic_flux.h
@@ -1,4 +0,0 @@
Magnetic Induction
==================
.. doxygenfile:: si/magnetic_induction.h
@@ -1,4 +0,0 @@
Mass
====
.. doxygenfile:: si/mass.h
@@ -1,4 +0,0 @@
Molar Energy
============
.. doxygenfile:: si/molar_energy.h
@@ -1,4 +0,0 @@
Momentum
========
.. doxygenfile:: si/momentum.h
@@ -1,4 +0,0 @@
Permeability
============
.. doxygenfile:: si/permeability.h
@@ -1,4 +0,0 @@
Permittivity
============
.. doxygenfile:: si/permittivity.h
@@ -1,4 +0,0 @@
Power
=====
.. doxygenfile:: si/power.h
@@ -1,4 +0,0 @@
Prefixes
========
.. doxygenfile:: si/prefixes.h
@@ -1,4 +0,0 @@
Pressure
========
.. doxygenfile:: si/pressure.h
@@ -1,4 +0,0 @@
Resistance
==========
.. doxygenfile:: si/resistance.h
@@ -1,4 +0,0 @@
Speed
=====
.. doxygenfile:: si/speed.h
@@ -1,4 +0,0 @@
Substance
=========
.. doxygenfile:: si/substance.h
@@ -1,4 +0,0 @@
Surface Tension
===============
.. doxygenfile:: si/surface_tension.h
@@ -1,4 +0,0 @@
Temperature
===========
.. doxygenfile:: si/temperature.h

Some files were not shown because too many files have changed in this diff Show More