pixi_python_package_template/mkdocs.yml at main · claudiushaag/pixi_python_package_template · 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
site_name: Pixi Python Template
# site_url: FIXME
# repo_url: FIXME
edit_uri: edit/main/docs/
copyright: Copyright &copy; 2025 FIXME
theme:
  name: material
  palette:
    primary: indigo
    accent: cyan
  features:
    - content.tabs.link
    - content.code.copy
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.tooltips
    - content.code.select
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
  icon:
    annotation: material/chevron-right-circle

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list  # must come before mkdocs-click!
  - md_in_html
  - mkdocs-click
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - macros:
      module_name: docs/scripts/macros
  - git-revision-date-localized:
      enable_creation_date: true
  - exporter:
      formats:
            pdf:
              enabled: !ENV [MKDOCS_EXPORTER_PDF_ENABLED, true]
              explicit: false
              concurrency: 4
              aggregator:
                enabled: true
                output: documentation.pdf
                covers: limits
      buttons:
          - title: Download as PDF
            icon: material-file-download-outline
            enabled: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.enabled
            attributes: !!python/name:mkdocs_exporter.formats.pdf.buttons.download.attributes
  - mkdocstrings

nav:
  - Home: index.md
  - CLI: cli.md
  - API: api.md
  - Documentation:
    - Updating: mkdocs.md
    - Markdown: markdown.md