mkdocs.yml

site_name: cmap
site_description: Colors and scientific colormaps for python, no dependencies
# strict: true

repo_name: tlambert03/cmap
repo_url: https://github.com/tlambert03/cmap
edit_uri: edit/main/docs/

watch:
  - src

nav:
  - Overview: index.md
  - Colors: colors.md
  - Colormaps: colormaps.md
  - Colormap Catalog: catalog/
  - API: api/
  - FAQ: faq.md

theme:
  name: "material"
  features:
    - content.tabs.link
    - content.code.annotate
    - navigation.indexes
    - navigation.instant
    - content.code.copy
  icon:
    logo: fontawesome/solid/swatchbook
    repo: fontawesome/brands/github
  favicon: images/favicon.ico
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: fontawesome/regular/lightbulb
        name: "Switch to dark mode"
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: fontawesome/solid/lightbulb
        name: "Switch to light mode"

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - md_in_html
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.extra
  - pymdownx.highlight
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: "#"

hooks:
  - docs/_hooks.py

plugins:
  - search:
      separator: '[\s\-\_,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - autorefs
  - literate-nav
  - gen-files:
      scripts:
        - docs/_gen_cmaps.py
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      js_files:
        - javascripts/filter.js
        - javascripts/cmap_charts.js
      css_files:
        - stylesheets/extra.css
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://numpy.org/doc/stable/objects.inv
          options:
            show_root_heading: true # default is false
            docstring_style: "numpy"
            line_length: 50 # default is 60
            # show_if_no_docstring: true # default is false
            # show_signature: false  # default is true
            show_signature_annotations: true # default is false
            annotations_path: "source" # default is 'brief'
            show_bases: false # default is true
            show_source: false # default is true

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/filter.js
  - https://cdnjs.cloudflare.com/ajax/libs/Chart.js/4.1.2/chart.umd.min.js
  - javascripts/cmap_charts.js