site_name: Cendat
site_url: https://mostlyunoriginal.github.io/cendat/
repo_url: https://github.com/mostlyunoriginal/cendat
repo_name: mostlyunoriginal/cendat

theme:
  name: material
  features:
    - navigation.tabs        # Top-level tabs (Home | Tutorials | Reference)
    - navigation.sections    # Collapsible sections in sidebar
    - navigation.expand      # Open sidebar by default
    - toc.integrate          # Table of contents on the right
    - content.code.copy      # "Copy" button on code blocks
  palette: 
    scheme: default          # Automatic light/dark mode support

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]       # CRITICAL: Points to your source code folder
          options:
            show_root_heading: true   # Show "cendat.CenDatHelper" as a header
            show_source: true         # Add a "Show Source" button to methods
  # - social  # Requires native cairo library: brew install cairo
  - mkdocs-jupyter:
      include_source: true    # Show cell source by default
      execute: false          # We execute notebooks in CI before building

markdown_extensions:
  - admonition              # For !!! tip, !!! note, !!! warning boxes
  - pymdownx.details        # For collapsible admonitions (??? syntax)
  - pymdownx.superfences    # Better fenced code blocks
  - pymdownx.highlight      # Code syntax highlighting

nav:
  - Home: index.md
  - Tutorials:
      - Overview: tutorials.md
      - ACS PUMS Microdata: tutorials/01_pums_microdata.ipynb
      - ACS 5-Year Aggregate: tutorials/02_acs5_aggregate.ipynb
      - Multi-Year Comparisons: tutorials/03_multi_year.ipynb
      - Working with Geometries: tutorials/04_geometries.ipynb
      - CPS Microdata: tutorials/05_cps_microdata.ipynb
  - API Reference:
      - Core: reference/core.md      