PicoPie/mkdocs.yml at main · inventhq/PicoPie · 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
site_name: PicoPie
site_description: A Pythonic binding for the PicoGK computational-geometry kernel
repo_url: https://github.com/Borderliner/PicoPie
docs_dir: docs

theme:
  name: material
  features:
    - navigation.sections
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
    - scheme: slate
      primary: indigo

nav:
  - Home: index.md
  - Tutorials:
    - QuickLearn: tutorials/QuickLearn.md
    - Novice:
      - 1 · Setup with uv: tutorials/novice/01-setup.md
      - 2 · First shapes: tutorials/novice/02-first-shapes.md
      - 3 · Booleans & export: tutorials/novice/03-booleans-and-export.md
    - Intermediate:
      - 1 · Implicit modeling: tutorials/intermediate/01-implicit-modeling.md
      - 2 · Meshes & files: tutorials/intermediate/02-meshes-and-files.md
      - 3 · Fields & metadata: tutorials/intermediate/03-fields-and-metadata.md
    - Advanced:
      - 1 · Performance: tutorials/advanced/01-performance.md
      - 2 · Reliability: tutorials/advanced/02-reliability.md
      - 3 · Viewer: tutorials/advanced/03-viewer.md
      - 4 · Web viewer: tutorials/advanced/04-web-viewer.md
    - Shapes (ShapeKernel):
      - 1 · Parametric shapes: tutorials/shapes/01-parametric-shapes.md
      - 2 · Frames & spines: tutorials/shapes/02-frames-and-spines.md
      - 3 · Lattices & implicits: tutorials/shapes/03-lattices-and-implicits.md
  - Gallery: gallery.md
  - API reference: api.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_source: false
            members_order: source
            docstring_style: google

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences