mkdocs.yml

site_name: C/C++ Linter Action
site_description: "Developer documentation from sources."
site_url: "https://shenxianpeng.github.io/cpp-linter-action"
repo_url: "https://github.com/shenxianpeng/cpp-linter-action"
edit_uri: "blob/master/docs/"
repo_name: "shenxianpeng/cpp-linter-action"
nav:
  - index.md
  - "Dev Docs":
    - API Reference/cpp_linter.md
    - API Reference/cpp_linter.run.md
    - API Reference/cpp_linter.clang_tidy.md
    - API Reference/cpp_linter.clang_tidy_yml.md
    - API Reference/cpp_linter.clang_format_xml.md
    - API Reference/cpp_linter.thread_comments.md

theme:
  name: material
  logo: images/icon_large.png
  features:
    - navigation.top
  favicon: images/icon_large.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: light blue
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: light)"
      scheme: slate
      primary: indigo
      accent: cyan
      toggle:
        icon: material/lightbulb
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - include-markdown
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            # show_if_no_docstring: true
            show_source: true
            heading_level: 2
      watch:
        - cpp_linter

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist
  - toc:
      permalink: true
  - pymdownx.highlight:
      linenums_style: pymdownx-inline
  - pymdownx.inlinehilite