mkdocs.yml

site_name: Documentation for Spurt

theme:
  name: "material"
  palette:
    # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color
    primary: "teal"
  # favicon: img/favicon.ico
  # logo: img/apple-touch-icon.png
  highlightjs: true


plugins:
  - search
  - mermaid2
  # plugin suggestions from here: https://mkdocstrings.github.io/recipes/
  - autorefs
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py
  # https://github.com/oprypin/mkdocs-literate-nav
  - literate-nav:
      nav_file: summary.md
  # https://mkdocstrings.github.io/python/usage/
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            members_order: alphabetical # source
          import:
          - https://docs.scipy.org/doc/scipy/objects.inv  # scipy doc objects
  - mkdocs-jupyter:
      include: ["docs/notebooks/*.ipynb"]
      ignore: ["docs/notebooks/data/*"]

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets:
      check_paths: true
  - footnotes
  - docs.mdx_bib:
      bibtex_file: docs/references.bib
      order: 'unsorted'
  - pymdownx.superfences:
        # make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js


watch:
- src/

nav:
- index.md
- getting-started.md
- tutorials.md
# - Tutorials:
#   - Notebook page: notebooks/walkthrough-basic.ipynb
#   # - Notebook page2: notebooks/walkthrough-basic.html
# - how-to-guides.md
# https://mkdocstrings.github.io/recipes/#generate-a-literate-navigation-file
# trailing slash: that mkdocs-literate-nav knows a summary.md file is in that folder.
- developer-setup.md
- Code Reference: reference/
# - background-theory.md