ImportSpy/mkdocs.yml at main · atellaluca/ImportSpy · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
site_name: ImportSpy
site_url: https://atellaluca.github.io/ImportSpy/
repo_url: https://github.com/atellaluca/importspy
repo_name: importspy/importspy

theme:
  name: material
  custom_dir: docs/overrides
  favicon: assets/favicon.ico
  logo: assets/importspy-logo.png
  palette:
    - scheme: default
      primary: purple
      accent: light blue
  features:
    - navigation.tabs
    - navigation.instant

nav:
  - Home: index.md
  - Introduction:
      - What is ImportSpy: intro/overview.md
      - Installation: intro/install.md
      - Quickstart: intro/quickstart.md
  - Operating Modes:
      - Embedded Mode: modes/embedded.md
      - CLI Mode: modes/cli.md
  - YAML Contracts:
      - Syntax: contracts/syntax.md
      - Examples: contracts/examples.md
  - Advanced Usage:
#      - CI/CD Integration: advanced/cicd.md
      - SpyModel Architecture: advanced/spymodel.md
      - Violation System: advanced/violations.md
  - Validation & Errors: errors/contract-violations.md
  - Use Cases: use_cases/index.md
  - API Reference: api-reference.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false

markdown_extensions:
  - pymdownx.snippets
  - admonition
  - pymdownx.tabbed:
      alternate_style: true