comlink-python/mkdocs.yml at main · swgoh-utils/comlink-python · 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
site_name: swgoh_comlink
site_description: Python interfaces for swgoh-comlink and built-in StatCalc
site_url: https://swgoh-utils.github.io/comlink-python/
repo_name: swgoh-utils/comlink-python
repo_url: https://github.com/swgoh-utils/comlink-python
edit_uri: edit/develop/docs/

theme:
  name: material
  custom_dir: overrides
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - "Home": index.md
  - "Guides":
      - "Migration Guide": migration.md
      - "Logging": logging.md
      - "Examples": examples.md
  - "API":
      - "SwgohComlink": api/comlink.md
      - "SwgohComlinkAsync": api/async.md
      - "StatCalc": api/statcalc.md
      - "Helpers": api/helpers.md
      - "Exceptions": api/exceptions.md

extra:
  # Versioned with mike: each release/* branch publishes its own folder on the
  # gh-pages branch (see "Publishing the docs" in CONTRIBUTING.md).
  version:
    provider: mike
    default: latest
    alias: true
  # Pre-release banner on every page (overrides/main.html). The deploy sets
  # DOCS_PRERELEASE from the release branch's version; local builds use the
  # default, which matches this line (2.x stable releases).
  prerelease: !ENV [DOCS_PRERELEASE, false]

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: google
            docstring_options:
              warn_unknown_params: false
            show_source: false
            members_order: source

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.inlinehilite