mkdocs.yml

site_name: Morrigan
site_description: Accretion and dynamical evolution of a system of protoplanets via giant impacts
site_url: https://proteus-framework.org/Morrigan
repo_url: https://github.com/FormingWorlds/Morrigan
repo_name: GitHub

copyright: '&copy; 2023-2026 <a href="https://formingworlds.space">Forming Worlds Lab</a>'

nav:
  - Home:
      - About: index.md
      - Getting started: getting_started.md

  - How-to guides:
      - Installation: How-to/installation.md
      - Running a model: How-to/running.md
      - Configuration: How-to/configuration.md
      - Coupling to PROTEUS: How-to/proteus_coupling.md
      - Replay an impact history: How-to/timeline_module.md
      - Grow a planet without dynamics: How-to/dummy_module.md
      - Testing: How-to/testing.md
      - Releasing: How-to/releasing.md

  - Tutorials:
      - Run a system standalone: Tutorials/standalone.md
      - Run PROTEUS with Morrigan: Tutorials/proteus_minimal.md

  - Explanations:
      - Model overview: Explanations/model.md
      - Code architecture: Explanations/code_architecture.md
      - Coupling to PROTEUS: Explanations/proteus_coupling.md
      - Limitations: Explanations/limitations.md

  - Reference:
      - Settings and inputs: Reference/parameters.md
      - API reference: Reference/api.md
      - Validation anchors:
          - Overview: Validation/index.md
          - Helper functions: Validation/helper_functions.md
          - Interaction timescales: Validation/interaction_timescales.md
          - Crossing pair: Validation/crossing_pair.md
          - Secular solution: Validation/secular_solution.md
          - Merger bookkeeping: Validation/merge_embryo.md
          - Crossing outcomes: Validation/orbit_cross_K25.md
          - Driver: Validation/driver.md
          - Ensemble statistics: Validation/ensemble_statistics.md

  - Source code:
      - GitHub repository: https://github.com/FormingWorlds/Morrigan

  - Issues:
      - GitHub issues: https://github.com/FormingWorlds/Morrigan/issues

  - Community:
      - Code of Conduct: Community/CODE_OF_CONDUCT.md
      - Contributing: Community/CONTRIBUTING.md
      - Contact: Community/contact.md
      - Developers: https://proteus-framework.org/people

  - Other PROTEUS modules:
      - The PROTEUS framework: proteus-framework.md
      - "\U0001F517 PROTEUS": https://proteus-framework.org/PROTEUS/
      - "\U0001F517 MORS": https://proteus-framework.org/MORS/
      - "\U0001F517 JANUS": https://proteus-framework.org/JANUS/
      - "\U0001F517 CALLIOPE": https://proteus-framework.org/CALLIOPE/
      - "\U0001F517 ZEPHYRUS": https://proteus-framework.org/ZEPHYRUS/
      - "\U0001F517 AGNI": https://www.h-nicholls.space/AGNI/
      - "\U0001F517 Obliqua": https://proteus-framework.org/Obliqua/
      - "\U0001F517 VULCAN": https://proteus-framework.org/VULCAN/
      - "\U0001F517 Zalmoxis": https://proteus-framework.org/Zalmoxis/
      - "\U0001F517 Aragog": https://proteus-framework.org/aragog/
      - "\U0001F517 SPIDER": https://proteus-framework.org/SPIDER/
      - "\U0001F517 Atmodeller": https://github.com/FormingWorlds/atmodeller
      - "\U0001F517 SOCRATES": https://proteus-framework.org/SOCRATES/

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.footer
    - navigation.tabs.sticky
    - content.code.copy
    - content.tabs.link

  # Fonts are self-hosted via stylesheets/fonts/fonts.css
  font: false

  # Default assets (the header stays dark in both schemes, so one glyph serves both)
  favicon: assets/favicon.svg
  logo: assets/glyph_phase_dark.png

  # The toggle icon shows the current mode, matching the project website
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: lucide/moon
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: lucide/sun
        name: Switch to dark mode

extra_css:
  - stylesheets/extra.css
  - stylesheets/layout.css
  - stylesheets/widths.css
  - stylesheets/footnotes.css

markdown_extensions:
  - admonition
  - attr_list
  - markdown_include.include:
      base_path: docs
  - pymdownx.extra
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - footnotes
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  generator: false
  social:
    - icon: material/web
      link: https://proteus-framework.org/
      name: PROTEUS website
    - icon: material/email
      link: mailto:dev@proteus-framework.org
      name: Mail PROTEUS developers
    - icon: fontawesome/brands/github
      link: https://github.com/FormingWorlds/Morrigan
      name: Morrigan on GitHub

extra_javascript:
  # Typesets the \( \) and \[ \] that pymdownx.arithmatex emits, and is the
  # renderer the rest of the PROTEUS documentation uses. It brings its own
  # styling, so nothing has to be added to extra_css to go with it.
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/header-links.js

plugins:
  - search
  - tags
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
          options:
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: yes
            docstring_section_style: table
            show_submodules: no
            show_source: true
            show_symbol_type_heading: true
            show_root_heading: true
            show_root_toc_entry: true
            show_docstring_attributes: true
            show_root_full_path: false
            members_order: alphabetical
            merge_init_into_class: yes
            filters: ["!^_"]

use_directory_urls: false

watch:
  - src/
  - README.md