mkdocs.yml

site_name: "VitroCal"
site_url: https://mpmbq2.github.io/vitrocal

docs_dir: docs/

# For more configuration on the theme, see https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
theme:
  name: readthedocs
  icon:
    logo: "fontawesome/solid/brain"
  features:
    - instant
    - tabs
  language: en

# We customize the navigation by hand to control the order
# in which pages show up.

nav:
  - Home: index.md
  - Example: ParameterTune.ipynb
  - API Reference: api.md

plugins:
  - search
  - mknotebooks:
      execute: false
      write_markdown: true
      allow_errors: false
      timeout: 1200
      binder: true
      binder_service_name: "gh"
      binder_branch: "master"
      binder_ui: "lab"
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src, notebooks]
          rendering:
            show_source: true
          # https://github.com/mkdocstrings/mkdocstrings/issues/278#issuecomment-831411193
          selection:
            docstring_style: restructured-text
          show_submodules: true
      # custom_templates: templates
      watch:
        - VitroCal
# Taken from here: https://squidfunk.github.io/mkdocs-material/extensions/codehilite/
markdown_extensions:
  - codehilite
  - admonition
  - pymdownx.superfences
  - markdown.extensions.attr_list

extra_css:
  - apidocs.css

extra_javascript:
  - config.js

repo_name: "mpmbq2/vitrocal"
repo_url: "https://github.com/mpmbq2/vitrocal"

# extra:
#   social:
#     - icon: "fontawesome/brands/github"
#       link: "https://github.com/Your GitHub username"