mkdocs.yml

site_name: dyce
site_description: Simple Python tools for exploring dice outcomes and other finite discrete probabilities
site_author: Matt Bogosian
copyright: <i>Copyright and other protections apply.
  Please see the accompanying <tt>LICENSE</tt> file for rights and restrictions governing use of this software.
  All rights not expressly waived or licensed are reserved.
  If that file is missing or appears to be modified from its original, then please contact the author before viewing or using this software in any capacity.</i>
docs_dir: docs
repo_url: https://github.com/posita/dyce/

theme:
  name: material
  custom_dir: overrides
  features:
    - content.code.annotate
    - content.tabs.link
    - navigation.footer
    - navigation.expand
    - navigation.sections
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:  # indicates the next setting
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: green
      toggle:  # indicates the next setting
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light-green
      accent: light-green
      toggle:  # indicates the next setting
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - admonition
  - footnotes
  - pycon
  # ---- BEGIN MathJax config ----
  - pymdownx.arithmatex:
      generic: true
      block_tag: 'pre'
  # ----- END MathJax config -----
  - pymdownx.details
  - pymdownx.highlight:
      default_lang: 'python'
      linenums: true
  - pymdownx.inlinehilite:
      custom_inline:
        # Support `#!math ...` inline syntax
        - name: math
          class: arithmatex
          format: !!python/object/apply:pymdownx.arithmatex.arithmatex_inline_format {kwds: {mode: generic}}
  - pymdownx.snippets:
      dedent_subsections: true
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        # Support ```math ...``` fence syntax
        - name: math
          class: arithmatex
          format: !!python/object/apply:pymdownx.arithmatex.arithmatex_fenced_format {kwds: {mode: generic, tag: pre}}
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tilde

exclude_docs: |
  __pycache__/
  snippets/

extra:
  version:
    provider: mike

extra_javascript:
  # ---- BEGIN MathJax config ----
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  # ----- END MathJax config -----

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            extensions:
              - griffe_warnings_deprecated
              - _griffe_ext.py:LifecycleExtension
            show_signature_annotations: true
hooks:
  # For copying LICENSE -> docs/license.md and README.md -> docs/index.md
  - _mkdocs_hooks.py

watch:
  - LICENSE
  - README.md
  - _griffe_ext.py
  - _mkdocs_hooks.py
  - docs
  - dyce
  - jupyter-lite.json
  - jupyter_lite_config.json
  - mkdocs.yml

nav:
  - Introduction: index.md
  - Countin’ with histograms and pools: countin.md
  - Applications and translations: translations.md
  - Release notes: notes.md
  - Contributing: contrib.md
  - License: license.md
  - API:
    - Core: dyce.md
    - Conveniences: dyce.d.md
    - Visualization:
      - Shared structures: dyce.viz.md
      - Matplotlib (optional): dyce.viz.matplotlib.md
      - Plotly: dyce.viz.plotly.md