python-build-standalone/mkdocs.yml at main · astral-sh/python-build-standalone · 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
site_name: Python Build Standalone
site_description: Self-contained, portable, high-performance Python distributions.
site_author: astral-sh
site_url: https://docs.astral.sh/python-build-standalone/
repo_url: https://github.com/astral-sh/python-build-standalone
repo_name: python-build-standalone
edit_uri: edit/main/docs/

# Keep the legacy Sphinx sources and build output out of the MkDocs site.
exclude_docs: |
  *.rst
  /conf.py
  /Makefile
  /_build/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.footer
    - navigation.top
    - toc.follow
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: astral-light
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: astral-dark
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: !relative $config_dir
      check_paths: true
  - pymdownx.superfences
  - toc:
      anchorlink: true
      anchorlink_class: toclink

plugins:
  - search

watch:
  - README.md

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/astral-sh/python-build-standalone
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/astral-sh

nav:
  - Introduction: index.md
  - Running Distributions: running.md
  - Building: building.md
  - Behavior Quirks: quirks.md
  - Technical Notes: technotes.md
  - Distribution Archives: distributions.md
  - Project Status: status.md

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn