ruff-sync/mkdocs.yml at main · Kilo59/ruff-sync · 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
site_name: ruff-sync
site_description: Synchronize Ruff linter configuration across Python projects.
site_url: https://kilo59.github.io/ruff-sync/

repo_name: Kilo59/ruff-sync
repo_url: https://github.com/Kilo59/ruff-sync
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo.png
  favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: amber
      accent: deep-purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: amber
      accent: deep-purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.tabs.link
    - navigation.expand
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - navigation.path
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - navigation.footer
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Kilo59/ruff-sync
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ruff-sync/

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:pymdownx.emoji.twemoji
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - toc:
      permalink: true
  - pymdownx.snippets:
      check_paths: true
      base_path: "."

plugins:
  - search
  - mike:
      alias_type: redirect
      canonical_version: stable
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: true
            show_if_no_docstring: true
            members_order: source
            separate_signature: true
            unwrap_annotated: true
            filters:
              - "!^_[^_]"

nav:
  - Home: index.md
  - Installation: installation.md
  - Usage:
      - Usage: usage.md
      - URL Resolution: url-resolution.md
      - Configuration: configuration.md
      - Best Practices: best-practices.md
      - Pre-commit: pre-commit.md
      - CI Integration: ci-integration.md
  - Troubleshooting: troubleshooting.md
  - Pre-defined Configs: pre-defined-configs.md
  - Agent Skill: agent-skill.md
  - Ruff Config Inspection: inspect.md
  - Contributing: contributing.md
  - API Reference: reference/