mkdocs.yml

site_name: whl2conda
repo_url: https://github.com/analog-cbarber/whl2conda
site_url: https://zuzukin.github.io/whl2conda
docs_dir: doc
site_dir: site
site_author: Christopher Barber
repo_name: GitHub
copyright: Copyright © 2023 Christopher Barber
exclude_docs: |
  /internal/

# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
#extra_css:
#  - style.css

theme:
  name: material
  language: en
#  custom_dir: docs/overrides
  font: 
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
#    - navigation.sections
#    - navigation.instant # browser back doesn't work well with this option
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
  highlight_js: true
  hljs_languages:
    python
    json
  logo: whl2conda.jpg
  favicon: whl2conda.jpg
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: white
      accent: orange
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: white
      accent: orange

extra:
  generator: false
  version:
    provider: mike
    default: stable

watch:
  # path is relative to this file
  - src/whl2conda

plugins:
  - search
  - autorefs
  - offline
  - awesome-pages:
      filename: nav.yml
  - mike:
      # These fields are all optional; the defaults are as below...
      canonical_version: stable
      version_selector: true
      css_dir: css
      javascript_dir: js
  # See https://mkdocstrings.github.io/
  - mkdocstrings:
      default_handler: python_xref
      # generate objects.inv sphinx inventory file in site/ dir to support external cross references
      enable_inventory: true
      handlers:
        python_xref:
          import:
            - https://docs.python.org/3/objects.inv

          options:
            docstring_style: google
            docstring_options:
              replace_admonitions: true
            filters:
              - "!^_"
              - "^__.*__$"
              - "!(has_empty_body)"
            heading_level: 2
            show_source: true
            show_submodules: false
            show_if_no_docstring: false
            show_category_heading: true
            show_signature_annotations: true
            separate_signature: true
            docstring_section_style: spacy
            relative_crossrefs: true

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
#          format: !!python/name:pymdownx.superfences.fence_code_format
  - attr_list