Fen-To-Board-Image/mkdocs.yml at main · ReedKrawiec/Fen-To-Board-Image · 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
site_name: FenToBoardImage
site_description: Convert FEN strings to chess board images
site_url: https://reedkrawiec.github.io/Fen-To-Board-Image/

repo_name: ReedKrawiec/Fen-To-Board-Image
repo_url: https://github.com/ReedKrawiec/Fen-To-Board-Image

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true
            docstring_section_style: spacy
            show_if_no_docstring: false
            heading_level: 2

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - def_list
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - API Reference:
      - Main API: api/main.md
      - FEN Parser: api/fen-parser.md
  - Examples: examples.md