mkdocs.yml

site_name: Solstice
site_description: Solstice is a library for scaling deep learning experiments in JAX.
site_author: Charles Jones
# site_url:
edit_uri: ""

strict: true

# Theme is based on Equinox docs... imitation is the highest form of flattery :)
theme:
  logo: solstice_summer_logo.png
  favicon: solstice_summer_logo.png
  name: "material"
  features:
        - navigation.sections
        - header.autohide
        - content.code.annotate
        - navigation.indexes
        - navigation.instant
  palette:
        - scheme: default
          primary: white
          accent: amber
          toggle:
              icon: material/weather-night
              name: Switch to dark mode
        - scheme: slate
          primary: black
          accent: amber
          toggle:
              icon: material/weather-sunny
              name: Switch to light mode
  icon:
      repo: fontawesome/brands/github
  # custom_dir: "docs/overrides"

plugins:
  - search
  - autorefs
  - mknotebooks
  - mkdocstrings:
      # detect all local changes with `mkdocs serve`, not just ones in docs/
      watch:
        - .
      handlers:
        python:
          selection:
              inherited_members: true
          rendering:
              # these defaults are to make the reference API look good,
              # override if necessary for other pages
              show_root_heading: false
              show_root_toc_entry: false
              show_root_full_path: true
              show_root_members_full_path: true
              show_if_no_docstring: false
              show_signature_annotations: true
              separate_signature: false
              show_source: true
              members_order: source
              line_length: 80
              merge_init_into_class: false
              docstring_section_style: list



repo_url: https://github.com/Charl-AI/Solstice
repo_name: Charl-AI/Solstice


extra_css:
    - css/style.css
    - css/material.css
    - css/mkdocstrings.css


markdown_extensions:
- admonition
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.snippets:
    check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- pymdownx.tasklist
- toc:
    permalink: "¤"
    toc_depth: 3

nav:
  - Getting Started: 'index.md'
  - 'primer.md'
  - 'from_flax_to_solstice.ipynb'

  - API Reference:
    - solstice: 'api/solstice.md'


  - Miscellaneous:
    - 'example_projects.md'
    - 'parallelism_strategies.md'
    - 'contributing.md'