mkdocs.yml

site_name: NNEVE docs
theme:
  name: material
  palette:
    - scheme: default
      primary: indygo
      accent: indygo
      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
nav:
  - Home: index.md
  - Quantum Oscillator:
      - Introduction: "quantum_oscillator/introduction.md"
      - Learning cycle: "quantum_oscillator/learning_cycle.md"
      - Reference:
          - class QONetwork: "quantum_oscillator/reference/network.md"
          - class QOConstants: "quantum_oscillator/reference/constants.md"
          - class QOTracker: "quantum_oscillator/reference/tracker.md"
          - class QOParams: "quantum_oscillator/reference/params.md"
  - Development:
      - Feature flow: "develop/feature.md"
      - Tox basics: "develop/tox_basics.md"
      - Documentation: "develop/docs.md"
      - Formatting code: "develop/formatting.md"
      - Quality checks: "develop/quality_checks.md"
  - HowTo:
      - Set up tox for development: "howto/tox_devenv.md"
      - Set up Visual Studio Code: "howto/set_up_vsc.md"
      - Set up environment in VSC: "howto/env_in_vsc.md"
  - Changelog: changelog.md
  - License: license.md
markdown_extensions:
  - toc:
      permalink: "#"
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - attr_list
  - admonition
  - md_in_html
  - mdx_truly_sane_lists
  - pymdownx.arithmatex:
      generic: true
plugins:
  - search
  - macros:
      include_dir: .
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy

extra_javascript:
  - termynal.js
  - custom.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
  - termynal.css
  - "https://fonts.googleapis.com/css?family=Fira+Mono"