pathlib-next/mkdocs.yml at main · jose-pr/pathlib-next · 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
site_name: pathlib_next
site_description: Generic Path Protocol based pathlib
site_url: https://jose-pr.github.io/pathlib-next/
repo_url: https://github.com/jose-pr/pathlib-next
repo_name: jose-pr/pathlib-next
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - content.code.copy

nav:
  - Home: index.md
  - Guides:
      - Schemes: guides/schemes.md
      - CLI: guides/cli.md
      - Extending: guides/extending.md
  - Benchmarks: benchmarks.md
  - Divergences from pathlib: divergences.md
  - API Reference:
      - Core Path: api/path.md
      - URI & Schemes: api/uri.md
      - Memory Path: api/mempath.md
      - Utilities: api/utils.md
      - Testing Contracts: api/testing.md
  - Changelog: changelog.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            merge_init_into_class: true
            show_if_no_docstring: false

markdown_extensions:
  - admonition
  - tables
  - pymdownx.snippets:
      base_path: ["."]
  - pymdownx.superfences