mkdocs.yml

# pyCircuit Documentation Configuration

site_name: pyCircuit
site_description: "Python-first hardware construction and architecture modeling with MLIR, C++ simulation, and Verilog generation"
site_author: PTO-ISA Contributors

repo_url: https://github.com/PTO-ISA/pyCircuit
repo_name: PTO-ISA/pyCircuit

copyright: "Copyright © 2024–2026 PTO-ISA Contributors"

# Configuration
docs_dir: docs
site_dir: _build/html
exclude_docs: |
  gates/logs/
  work-items/
  reviews/
  rfcs/contracts/

# Theme
theme:
  name: material
  logo: figures/pycircuit-logo.png
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

# Markdown extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

# Navigation
nav:
  - Home: index.md
  - Get Started:
      - Overview: getting-started/index.md
      - Installation: getting-started/installation.md
      - Hello Counter: getting-started/quickstart.md
      - Build and Run: getting-started/tutorial.md
  - Language:
      - Overview: reference/index.md
      - Python Source: reference/language.md
      - Functional Floating Source Units: reference/functional-float-source-units.md
      - Language and Execution: reference/language-specification.md
      - Diagnostics: reference/diagnostics.md
      - Names and Source Ownership: reference/name-mangling.md
      - Structs and Tables: reference/spec-collections.md
      - Enums: reference/spec-enums.md
      - Queues: reference/spec-queues.md
  - Architecture:
      - Overview: architecture/overview.md
      - Compiler Pipeline: architecture/compiler-pipeline.md
      - Routed ACIR Anchor: architecture/routed-anchor.md
      - Selected Module Entries: architecture/entry-boundary.md
      - Saved Anchors: architecture/saved-anchor.md
      - Simulation: architecture/simulation.md
      - System Execution: architecture/system-execution.md
      - System Host Integration Design: architecture/system-host-integration.md
      - Combinational and Progress Analysis: architecture/progress-analysis.md
  - Development:
      - Overview: development/index.md
      - Source Authoring: development/agent-frontend-guide.md
      - Source-unit Workflow: development/source-unit-workflow.md
      - Physical RTL Export: development/physical-rtl-export.md
      - Compiler Benchmark Delivery: development/compiler-benchmark-delivery.md
      - Implementation Guide: development/implementation-guide.md
      - Contributing: development/contributing-workflow.md
      - Testing: development/testing-and-gates.md
      - Review and Merge: development/review-and-merge.md
      - Known Limitations: development/known-limitations.md
      - Issue 307 and 319 Handoff:
          - Review Checklist: development/issue-307-319-review-checklist.md
          - Example Inventory: development/issue-307-319-examples.md
          - Decisions and Bounds: development/issue-307-319-decisions.md
          - Execution Status: development/issue-307-319-execution-status.md
          - Execution Prompt: development/issue-307-319-agent-prompt.md
      - Project Governance: development/project-governance.md
      - Extension Specifications:
          - Boolean Record Fields: rfcs/boolean-record-fields.md
          - Literal Provider Constants: rfcs/literal-provider-constants.md
          - Four-state Values and System: rfcs/four-state-system.md
          - Serial Rule and Method: rfcs/serial-rule-method/README.md
          - Source Semantics: rfcs/serial-rule-method/source-semantics.md
          - Pure Helpers: rfcs/serial-rule-method/pure-helpers.md
          - MLIR Pipeline: rfcs/serial-rule-method/mlir-pipeline.md
          - Cross-instance Method Lowering: rfcs/serial-rule-method/cross-instance-lowering.md
          - Sampled Transaction Admission: rfcs/serial-rule-method/sampled-admission.md
          - Sampled Body Effects: rfcs/serial-rule-method/sampled-body-effects.md
          - Whole-Bits Branch State: rfcs/serial-rule-method/branch-state-ssa.md
          - Conditional Calls and Effects: rfcs/serial-rule-method/conditional-effects.md
          - Transaction Publication Summary: rfcs/serial-rule-method/publication-summary.md
          - Observation Identity: rfcs/serial-rule-method/observation-identity.md
          - Resource Extensions: rfcs/serial-rule-method/extensions.md
          - Acceptance Checklist: rfcs/serial-rule-method/acceptance.md
          - Implementation Plan: rfcs/serial-rule-method/implementation-plan.md
          - Extension Roadmap: rfcs/serial-rule-method/extension-roadmap.md
      - Repository Management: development/repository-management.md
      - Repository Layout: development/repository-layout.md
      - Verification Evidence: gates/README.md
      - License History: legal/AC-RELICENSE-BSD-3-CLAUSE.md
# Plugins
plugins:
  - search:
      lang: en

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/PTO-ISA/pyCircuit
    - icon: fontawesome/brands/python
      link: https://python.org