mp-units/mkdocs.yml

# Project information
site_name: "mp-units"
site_description: "The quantities and units library for C++"
site_url: https://mpusz.github.io/mp-units
site_author: "mp-units Team"

# Repository
repo_name: mpusz/mp-units
repo_url: https://github.com/mpusz/mp-units

# Copyright
copyright: Copyright © 2018-2023 Mateusz Pusz

# Watch additional directories for changes during 'mkdocs serve'
watch:
  - src/systems/include/mp-units/systems

# Hooks
hooks:
  - scripts/systems_reference.py

# Configuration
theme:
  name: material
  logo: assets/images/mp-units-transparent-white.svg
  favicon: assets/images/mp-units-color.svg
  custom_dir: docs/.overrides
  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - navigation.expand
    - navigation.indexes
    # - navigation.sections
    - navigation.tabs
    - navigation.footer
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono

# Plugins
plugins:
  - blog
  - exclude:
      glob:
        - api_reference/src/*
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags
  - search
  - social:
      enabled: !ENV [CI, false]
      cards_layout_options:
        background_color: "#00599c"
  - tags

# Customization
extra:
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/ce_embed.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

# Page tree
nav:
  - Home: index.md
  - Getting Started:
      - Getting Started: getting_started/index.md
      - About mp-units: getting_started/about.md
      - Quick Start: getting_started/quick_start.md
      - Look and Feel: getting_started/look_and_feel.md
      - Safety Features: getting_started/safety_features.md
      - Project Structure: getting_started/project_structure.md
      - C++ compiler support (API/ABI): getting_started/cpp_compiler_support.md
      - Installation and Usage: getting_started/installation_and_usage.md
      - Contributing: getting_started/contributing.md
      - FAQ: getting_started/faq.md
  - Tutorials:
      - Tutorials: tutorials/index.md
      - "Quick Start":
          - "Your First Quantities": tutorials/quick_start/first_quantities.md
          - "Simple Math": tutorials/quick_start/simple_math.md
          - "Building a Calculator": tutorials/quick_start/building_calculator.md
      - "Working with Units":
          - "Unit Conversions": tutorials/working_with_units/unit_conversions.md
          - "Safe and Unsafe Conversions": tutorials/working_with_units/safe_unsafe_conversions.md
          - "Extracting Numeric Values": tutorials/working_with_units/extracting_numeric_values.md
      - "Type Safety":
          - "Compile-Time Protection": tutorials/type_safety/compile_time_protection.md
          - "Automatic Dimensional Analysis": tutorials/type_safety/dimensional_analysis.md
          - "Quantity Specifications": tutorials/type_safety/quantity_specifications.md
          - "Generic Interfaces": tutorials/type_safety/generic_interfaces.md
      - "Affine Space":
          - "Points and Quantities": tutorials/affine_space/points_and_quantities.md
          - "Point Origins": tutorials/affine_space/point_origins.md
          - "Temperature Handling": tutorials/affine_space/temperature_handling.md
          - "Temperature Applications": tutorials/affine_space/temperature_applications.md
  - User's Guide:
      - User's Guide: users_guide/index.md
      - Terms and Definitions: users_guide/terms_and_definitions.md
      - Framework Basics:
          - Interface Introduction: users_guide/framework_basics/interface_introduction.md
          - Design Overview: users_guide/framework_basics/design_overview.md
          - Systems of Quantities: users_guide/framework_basics/systems_of_quantities.md
          - Systems of Units: users_guide/framework_basics/systems_of_units.md
          - Simple and Typed Quantities: users_guide/framework_basics/simple_and_typed_quantities.md
          - Value Conversions: users_guide/framework_basics/value_conversions.md
          - Character of a Quantity: users_guide/framework_basics/character_of_a_quantity.md
          - Dimensionless Quantities: users_guide/framework_basics/dimensionless_quantities.md
          - Quantity Arithmetics: users_guide/framework_basics/quantity_arithmetics.md
          - Generic Interfaces: users_guide/framework_basics/generic_interfaces.md
          - Faster-than-lightspeed Constants: users_guide/framework_basics/faster_than_lightspeed_constants.md
          - The Affine Space: users_guide/framework_basics/the_affine_space.md
          - Type Introspection: users_guide/framework_basics/type_introspection.md
          - Concepts: users_guide/framework_basics/concepts.md
          - Text Output: users_guide/framework_basics/text_output.md
      - Systems:
          - Systems: users_guide/systems/index.md
          - International System of Quantities (ISQ): users_guide/systems/isq.md
          - International System of Units (SI): users_guide/systems/si.md
          - IAU Astronomical Units: users_guide/systems/iau.md
          - Centimetre-Gram-Second (CGS) System: users_guide/systems/cgs.md
          - Yard-Pound Systems: users_guide/systems/yard_pound.md
          - Strong Angular System: users_guide/systems/strong_angular_system.md
          - Natural Units: users_guide/systems/natural_units.md
  - Workshops:
      - Workshops: workshops/index.md
      - Foundation:
          - "Refactor to Strong Types": workshops/foundation/refactor_to_strong_types.md
          - "Generic, Type-Safe Interfaces": workshops/foundation/generic_type_safe_interfaces.md
          - "Extracting Numeric Values": workshops/foundation/extracting_numeric_values.md
          - "Working with Temperatures": workshops/foundation/working_with_temperatures.md
          - "Affine Spaces and Origins": workshops/foundation/affine_spaces.md
          - "Interop with std::chrono": workshops/foundation/interop_with_std_chrono.md
      - Extensions:
          - "Custom Dimensionless Units": workshops/extensions/custom_dimensionless_units.md
          - "Typed Quantities of Same Kind": workshops/extensions/typed_quantities_same_kind.md
          - "Custom Quantity Specifications": workshops/extensions/custom_quantity_specifications.md
          - "Custom Base Dimensions": workshops/extensions/custom_base_dimensions.md
          - "Distinct Quantity Kinds": workshops/extensions/distinct_quantity_kinds.md
      - Advanced:
          - "Strongly-Typed Counts": workshops/advanced/strongly_typed_counts.md
          - "Faster-than-Lightspeed Constants": workshops/advanced/faster_than_lightspeed_constants.md
          - "Incremental Migration": workshops/advanced/incremental_migration.md
  - How-to Guides:
      - How-to Guides: how_to_guides/index.md
      - Advanced Usage:
          - Overview: how_to_guides/advanced_usage/index.md
          - Pure Dimensional Analysis: how_to_guides/advanced_usage/pure_dimensional_analysis.md
      - Integration:
          - Overview: how_to_guides/integration/index.md
          - Working with Legacy Interfaces: how_to_guides/integration/working_with_legacy_interfaces.md
          - Using Custom Representation Types: how_to_guides/integration/using_custom_representation_types.md
          - Interoperability with Other Libraries: how_to_guides/integration/interoperability_with_other_libraries.md
          - Wide Compatibility: how_to_guides/integration/wide_compatibility.md
  - Examples:
      - Examples: examples/index.md
      - Tags: examples/tags.md
      - Beginner:
          - hello_units: examples/hello_units.md
          - avg_speed: examples/avg_speed.md
          - si_constants: examples/si_constants.md
      - Intermediate:
          - foot_pound_second: examples/foot_pound_second.md
          - spectroscopy_units: examples/spectroscopy_units.md
          - storage_tank: examples/storage_tank.md
          - capacitor_time_curve: examples/capacitor_time_curve.md
          - hw_voltage: examples/hw_voltage.md
          - measurement: examples/measurement.md
          - currency: examples/currency.md
          - strong_angular_quantities: examples/strong_angular_quantities.md
          - total_energy: examples/total_energy.md
      - Advanced:
          - unmanned_aerial_vehicle: examples/unmanned_aerial_vehicle.md
          - glide_computer: examples/glide_computer.md
          - kalman_filter: examples/kalman_filter.md
  - Reference:
      - Reference: reference/index.md
      - Cheat Sheet: reference/cheat_sheet.md
      - Systems Reference:
          - Overview: reference/systems_reference/index.md
          - Systems:
              - Angular: reference/systems_reference/systems/angular.md
              - Astronomy: reference/systems_reference/systems/astronomy.md
              - CGS: reference/systems_reference/systems/cgs.md
              - Core: reference/systems_reference/systems/core.md
              - HEP: reference/systems_reference/systems/hep.md
              - IAU: reference/systems_reference/systems/iau.md
              - IEC: reference/systems_reference/systems/iec.md
              - Imperial: reference/systems_reference/systems/imperial.md
              - ISQ: reference/systems_reference/systems/isq.md
              - ISQ Angle: reference/systems_reference/systems/isq_angle.md
              - Natural: reference/systems_reference/systems/natural.md
              - SI: reference/systems_reference/systems/si.md
              - Typographic: reference/systems_reference/systems/typographic.md
              - USC: reference/systems_reference/systems/usc.md
              - Yard Pound: reference/systems_reference/systems/yard_pound.md
          - Dimensions: reference/systems_reference/dimensions_index.md
          - Quantities: reference/systems_reference/quantities_index.md
          - Units: reference/systems_reference/units_index.md
          - Prefixes: reference/systems_reference/prefixes_index.md
          - Point Origins: reference/systems_reference/point_origins_index.md
          - Quantity Hierarchies:
              - Overview: reference/systems_reference/hierarchies/index.md
              - Joule_Thomson_coefficient: reference/systems_reference/hierarchies/Joule_Thomson_coefficient.md
              - Massieu_function: reference/systems_reference/hierarchies/Massieu_function.md
              - Planck_function: reference/systems_reference/hierarchies/Planck_function.md
              - Poynting_vector: reference/systems_reference/hierarchies/Poynting_vector.md
              - absorbed_dose: reference/systems_reference/hierarchies/absorbed_dose.md
              - acceleration: reference/systems_reference/hierarchies/acceleration.md
              - action: reference/systems_reference/hierarchies/action.md
              - activity: reference/systems_reference/hierarchies/activity.md
              - admittance: reference/systems_reference/hierarchies/admittance.md
              - amount_of_substance: reference/systems_reference/hierarchies/amount_of_substance.md
              - angle: reference/systems_reference/hierarchies/angle.md
              - angular_acceleration (isq): reference/systems_reference/hierarchies/angular_acceleration_isq.md
              - angular_acceleration (isq_angle): reference/systems_reference/hierarchies/angular_acceleration_isq_angle.md
              - angular_frequency (isq): reference/systems_reference/hierarchies/angular_frequency_isq.md
              - angular_frequency (isq_angle): reference/systems_reference/hierarchies/angular_frequency_isq_angle.md
              - angular_impulse: reference/systems_reference/hierarchies/angular_impulse.md
              - angular_momentum (isq): reference/systems_reference/hierarchies/angular_momentum_isq.md
              - angular_momentum (isq_angle): reference/systems_reference/hierarchies/angular_momentum_isq_angle.md
              - angular_repetency (isq): reference/systems_reference/hierarchies/angular_repetency_isq.md
              - angular_repetency (isq_angle): reference/systems_reference/hierarchies/angular_repetency_isq_angle.md
              - angular_velocity (isq): reference/systems_reference/hierarchies/angular_velocity_isq.md
              - angular_velocity (isq_angle): reference/systems_reference/hierarchies/angular_velocity_isq_angle.md
              - area: reference/systems_reference/hierarchies/area.md
              - attenuation: reference/systems_reference/hierarchies/attenuation.md
              - call_intensity: reference/systems_reference/hierarchies/call_intensity.md
              - capacitance: reference/systems_reference/hierarchies/capacitance.md
              - coefficient_of_heat_transfer: reference/systems_reference/hierarchies/coefficient_of_heat_transfer.md
              - complex_power: reference/systems_reference/hierarchies/complex_power.md
              - compressibility: reference/systems_reference/hierarchies/compressibility.md
              - conductivity: reference/systems_reference/hierarchies/conductivity.md
              - cubic_expansion_coefficient: reference/systems_reference/hierarchies/cubic_expansion_coefficient.md
              - curvature: reference/systems_reference/hierarchies/curvature.md
              - damping_coefficient: reference/systems_reference/hierarchies/damping_coefficient.md
              - density_of_heat_flow_rate: reference/systems_reference/hierarchies/density_of_heat_flow_rate.md
              - dimensionless: reference/systems_reference/hierarchies/dimensionless.md
              - dose_equivalent: reference/systems_reference/hierarchies/dose_equivalent.md
              - duration: reference/systems_reference/hierarchies/duration.md
              - dynamic_viscosity: reference/systems_reference/hierarchies/dynamic_viscosity.md
              - electric_charge: reference/systems_reference/hierarchies/electric_charge.md
              - electric_charge_density: reference/systems_reference/hierarchies/electric_charge_density.md
              - electric_constant: reference/systems_reference/hierarchies/electric_constant.md
              - electric_current: reference/systems_reference/hierarchies/electric_current.md
              - electric_current_density: reference/systems_reference/hierarchies/electric_current_density.md
              - electric_dipole_moment: reference/systems_reference/hierarchies/electric_dipole_moment.md
              - electric_field_strength: reference/systems_reference/hierarchies/electric_field_strength.md
              - electric_flux: reference/systems_reference/hierarchies/electric_flux.md
              - electric_polarization: reference/systems_reference/hierarchies/electric_polarization.md
              - electric_potential: reference/systems_reference/hierarchies/electric_potential.md
              - electromagnetic_energy_density: reference/systems_reference/hierarchies/electromagnetic_energy_density.md
              - energy (isq): reference/systems_reference/hierarchies/energy_isq.md
              - energy (natural): reference/systems_reference/hierarchies/energy_natural.md
              - energy_squared: reference/systems_reference/hierarchies/energy_squared.md
              - entropy: reference/systems_reference/hierarchies/entropy.md
              - force: reference/systems_reference/hierarchies/force.md
              - frequency: reference/systems_reference/hierarchies/frequency.md
              - group_speed: reference/systems_reference/hierarchies/group_speed.md
              - heat_capacity: reference/systems_reference/hierarchies/heat_capacity.md
              - heat_flow_rate: reference/systems_reference/hierarchies/heat_flow_rate.md
              - impedance: reference/systems_reference/hierarchies/impedance.md
              - inductance: reference/systems_reference/hierarchies/inductance.md
              - inverse_energy: reference/systems_reference/hierarchies/inverse_energy.md
              - irradiance: reference/systems_reference/hierarchies/irradiance.md
              - kinematic_viscosity: reference/systems_reference/hierarchies/kinematic_viscosity.md
              - length: reference/systems_reference/hierarchies/length.md
              - linear_density_of_electric_charge: reference/systems_reference/hierarchies/linear_density_of_electric_charge.md
              - linear_electric_current_density: reference/systems_reference/hierarchies/linear_electric_current_density.md
              - linear_expansion_coefficient: reference/systems_reference/hierarchies/linear_expansion_coefficient.md
              - linear_mass_density: reference/systems_reference/hierarchies/linear_mass_density.md
              - luminous_intensity: reference/systems_reference/hierarchies/luminous_intensity.md
              - magnetic_constant: reference/systems_reference/hierarchies/magnetic_constant.md
              - magnetic_dipole_moment: reference/systems_reference/hierarchies/magnetic_dipole_moment.md
              - magnetic_flux: reference/systems_reference/hierarchies/magnetic_flux.md
              - magnetic_flux_density: reference/systems_reference/hierarchies/magnetic_flux_density.md
              - magnetic_moment: reference/systems_reference/hierarchies/magnetic_moment.md
              - magnetic_vector_potential: reference/systems_reference/hierarchies/magnetic_vector_potential.md
              - magnetization: reference/systems_reference/hierarchies/magnetization.md
              - mass: reference/systems_reference/hierarchies/mass.md
              - mass_change_rate: reference/systems_reference/hierarchies/mass_change_rate.md
              - mass_density: reference/systems_reference/hierarchies/mass_density.md
              - mass_flow: reference/systems_reference/hierarchies/mass_flow.md
              - mass_flow_rate: reference/systems_reference/hierarchies/mass_flow_rate.md
              - modulation_rate: reference/systems_reference/hierarchies/modulation_rate.md
              - modulus_of_compression: reference/systems_reference/hierarchies/modulus_of_compression.md
              - modulus_of_elasticity: reference/systems_reference/hierarchies/modulus_of_elasticity.md
              - modulus_of_rigidity: reference/systems_reference/hierarchies/modulus_of_rigidity.md
              - moment_of_force (isq): reference/systems_reference/hierarchies/moment_of_force_isq.md
              - moment_of_force (isq_angle): reference/systems_reference/hierarchies/moment_of_force_isq_angle.md
              - moment_of_inertia (isq): reference/systems_reference/hierarchies/moment_of_inertia_isq.md
              - moment_of_inertia (isq_angle): reference/systems_reference/hierarchies/moment_of_inertia_isq_angle.md
              - momentum: reference/systems_reference/hierarchies/momentum.md
              - mutual_inductance: reference/systems_reference/hierarchies/mutual_inductance.md
              - permeability: reference/systems_reference/hierarchies/permeability.md
              - permeance: reference/systems_reference/hierarchies/permeance.md
              - permittivity: reference/systems_reference/hierarchies/permittivity.md
              - phase_coefficient (isq): reference/systems_reference/hierarchies/phase_coefficient_isq.md
              - phase_coefficient (isq_angle): reference/systems_reference/hierarchies/phase_coefficient_isq_angle.md
              - phase_speed: reference/systems_reference/hierarchies/phase_speed.md
              - phase_speed_of_electromagnetic_waves: reference/systems_reference/hierarchies/phase_speed_of_electromagnetic_waves.md
              - power: reference/systems_reference/hierarchies/power.md
              - pressure: reference/systems_reference/hierarchies/pressure.md
              - pressure_coefficient: reference/systems_reference/hierarchies/pressure_coefficient.md
              - propagation_coefficient (isq): reference/systems_reference/hierarchies/propagation_coefficient_isq.md
              - propagation_coefficient (isq_angle): reference/systems_reference/hierarchies/propagation_coefficient_isq_angle.md
              - protoflux: reference/systems_reference/hierarchies/protoflux.md
              - radiance: reference/systems_reference/hierarchies/radiance.md
              - radiant_energy_density: reference/systems_reference/hierarchies/radiant_energy_density.md
              - radiant_exitance: reference/systems_reference/hierarchies/radiant_exitance.md
              - radiant_exposure: reference/systems_reference/hierarchies/radiant_exposure.md
              - radiant_intensity: reference/systems_reference/hierarchies/radiant_intensity.md
              - reactive_power: reference/systems_reference/hierarchies/reactive_power.md
              - relative_pressure_coefficient: reference/systems_reference/hierarchies/relative_pressure_coefficient.md
              - reluctance: reference/systems_reference/hierarchies/reluctance.md
              - repetency: reference/systems_reference/hierarchies/repetency.md
              - resistivity: reference/systems_reference/hierarchies/resistivity.md
              - rotational_frequency: reference/systems_reference/hierarchies/rotational_frequency.md
              - second_axial_moment_of_area: reference/systems_reference/hierarchies/second_axial_moment_of_area.md
              - second_polar_moment_of_area: reference/systems_reference/hierarchies/second_polar_moment_of_area.md
              - section_modulus: reference/systems_reference/hierarchies/section_modulus.md
              - solid_angle: reference/systems_reference/hierarchies/solid_angle.md
              - solid_angular_measure: reference/systems_reference/hierarchies/solid_angular_measure.md
              - specific_energy: reference/systems_reference/hierarchies/specific_energy.md
              - specific_entropy: reference/systems_reference/hierarchies/specific_entropy.md
              - specific_gas_constant: reference/systems_reference/hierarchies/specific_gas_constant.md
              - specific_heat_capacity: reference/systems_reference/hierarchies/specific_heat_capacity.md
              - specific_volume: reference/systems_reference/hierarchies/specific_volume.md
              - spectral_irradiance: reference/systems_reference/hierarchies/spectral_irradiance.md
              - spectral_radiance: reference/systems_reference/hierarchies/spectral_radiance.md
              - spectral_radiant_energy: reference/systems_reference/hierarchies/spectral_radiant_energy.md
              - spectral_radiant_energy_density_in_terms_of_wavelength: reference/systems_reference/hierarchies/spectral_radiant_energy_density_in_terms_of_wavelength.md
              - spectral_radiant_energy_density_in_terms_of_wavenumber: reference/systems_reference/hierarchies/spectral_radiant_energy_density_in_terms_of_wavenumber.md
              - spectral_radiant_exitance: reference/systems_reference/hierarchies/spectral_radiant_exitance.md
              - spectral_radiant_exposure: reference/systems_reference/hierarchies/spectral_radiant_exposure.md
              - spectral_radiant_flux: reference/systems_reference/hierarchies/spectral_radiant_flux.md
              - spectral_radiant_intensity: reference/systems_reference/hierarchies/spectral_radiant_intensity.md
              - speed: reference/systems_reference/hierarchies/speed.md
              - surface_coefficient_of_heat_transfer: reference/systems_reference/hierarchies/surface_coefficient_of_heat_transfer.md
              - surface_density_of_electric_charge: reference/systems_reference/hierarchies/surface_density_of_electric_charge.md
              - surface_mass_density: reference/systems_reference/hierarchies/surface_mass_density.md
              - surface_tension: reference/systems_reference/hierarchies/surface_tension.md
              - thermal_conductance: reference/systems_reference/hierarchies/thermal_conductance.md
              - thermal_conductivity: reference/systems_reference/hierarchies/thermal_conductivity.md
              - thermal_diffusivity: reference/systems_reference/hierarchies/thermal_diffusivity.md
              - thermal_insulance: reference/systems_reference/hierarchies/thermal_insulance.md
              - thermal_resistance: reference/systems_reference/hierarchies/thermal_resistance.md
              - thermodynamic_temperature: reference/systems_reference/hierarchies/thermodynamic_temperature.md
              - traffic_intensity: reference/systems_reference/hierarchies/traffic_intensity.md
              - transfer_rate: reference/systems_reference/hierarchies/transfer_rate.md
              - volume: reference/systems_reference/hierarchies/volume.md
              - volume_flow_rate: reference/systems_reference/hierarchies/volume_flow_rate.md
      - API Reference: reference/api_reference.md
      - Glossary: reference/glossary.md
      - Bibliography: reference/bibliography.md
  - Blog:
      - blog/index.md
  - Release Notes: release_notes.md