site_name: ucon

site_url: https://docs.ucon.dev

repo_url: https://github.com/withtwoemms/ucon

repo_name: withtwoemms/ucon

theme:

name: material

logo: assets/ucon-logo.svg

favicon: assets/ucon-logo.png

palette:

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: custom

accent: custom

toggle:

icon: material/brightness-7

name: Light mode

- media: "(prefers-color-scheme: light)"

scheme: default

primary: custom

accent: custom

toggle:

icon: material/brightness-4

name: Dark mode

features:

- navigation.sections

- navigation.expand

- navigation.indexes

- navigation.tabs

- content.code.copy

- content.code.annotate

- search.suggest

- search.highlight

icon:

repo: fontawesome/brands/github

extra_css:

- stylesheets/extra.css

exclude_docs: |

internal/

external/ucon-tools/*.*

nav:

- Home: index.md

- Getting Started:

- getting-started/index.md

- Why ucon: getting-started/why-ucon.md

- Quickstart: getting-started/quickstart.md

- Installation: getting-started/installation.md

- Guides:

- guides/index.md

- Pydantic Integration: guides/pydantic-integration.md

- Config Safety: guides/dimensional-safety-config.md

- Dimensional Analysis: guides/dimensional-analysis.md

- Custom Units & Graphs: guides/custom-units-and-graphs.md

- Conversion Contexts: guides/conversion-contexts.md

- Natural Units: guides/natural-units.md

- MCP Server:

- external/ucon-tools/docs/guides/mcp-server/index.md

- Custom Units: external/ucon-tools/docs/guides/mcp-server/custom-units.md

- Registering Formulas: external/ucon-tools/docs/guides/mcp-server/registering-formulas.md

- Domain Walkthroughs:

- guides/domain-walkthroughs/index.md

- Nursing Dosage: guides/domain-walkthroughs/nursing-dosage.md

- Chemical Engineering: guides/domain-walkthroughs/chemical-engineering.md

- Aerospace: guides/domain-walkthroughs/aerospace.md

- Finance: guides/domain-walkthroughs/finance.md

- Electrical Engineering: guides/domain-walkthroughs/electrical-engineering.md

- Domain-Specific Bases:

- guides/domain-bases/index.md

- Radiation Dosimetry: guides/domain-bases/radiation-dosimetry.md

- Pharmacology: guides/domain-bases/pharmacology.md

- Clinical Chemistry: guides/domain-bases/clinical-chemistry.md

- Classical Mechanics: guides/domain-bases/classical-mechanics.md

- Thermodynamics: guides/domain-bases/thermodynamics.md

- Scientific Computing:

- NumPy Arrays: guides/numpy-arrays.md

- Pandas Integration: guides/pandas-integration.md

- Polars Integration: guides/polars-integration.md

- Reference:

- reference/index.md

- API: reference/api.md

- Performance: reference/performance.md

- Units & Dimensions: reference/units-and-dimensions.md

- MCP Tools: external/ucon-tools/docs/reference/mcp-tools.md

- Serialization Format: reference/serialization-format.md

- Scales & Prefixes: reference/scales-and-prefixes.md

- Module Reference:

- reference/modules/index.md

- ucon.basis: reference/modules/basis.md

- ucon.basis.builtin: reference/modules/basis-builtin.md

- ucon.basis.transforms: reference/modules/basis-transforms.md

- ucon.basis.graph: reference/modules/basis-graph.md

- ucon.checking: reference/modules/checking.md

- ucon.constants: reference/modules/constants.md

- ucon.contexts: reference/modules/contexts.md

- ucon.core: reference/modules/core.md

- ucon.dimension: reference/modules/dimension.md

- ucon.graph: reference/modules/graph.md

- ucon.maps: reference/modules/maps.md

- ucon.packages: reference/modules/packages.md

- ucon.parsing: reference/modules/parsing.md

- ucon.units: reference/modules/units.md

- ucon.integrations.numpy: reference/modules/integrations-numpy.md

- ucon.integrations.pandas: reference/modules/integrations-pandas.md

- ucon.integrations.polars: reference/modules/integrations-polars.md

- ucon.integrations.pydantic: reference/modules/integrations-pydantic.md

- Architecture:

- architecture/index.md

- Design Principles: architecture/design-principles.md

- Kind-of-Quantity Problem: architecture/kind-of-quantity.md

- ConversionGraph: architecture/conversion-graph.md

- Dual-Graph Architecture: architecture/dual-graph-architecture.md

- Suggestions & Recovery: architecture/suggestions-and-recovery.md

- Comparison with Pint: architecture/comparison-with-pint.md

plugins:

- search

- mkdocstrings:

handlers:

python:

options:

show_source: true

show_root_heading: true

members_order: source

markdown_extensions:

- pymdownx.highlight:

anchor_linenums: true

- pymdownx.superfences:

custom_fences:

- name: mermaid

class: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.tabbed:

alternate_style: true

- pymdownx.arithmatex:

generic: true

- admonition

- pymdownx.details

- attr_list

- md_in_html

- tables

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

- toc:

permalink: true

copyright: "© 2020-2026 The Radiativity Company"

extra:

social:

- icon: fontawesome/brands/github

link: https://github.com/withtwoemms/ucon