pitloom/mkdocs.yml at main · bact/pitloom · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# SPDX-FileCopyrightText: 2026-present Arthit Suriyawongkul
# SPDX-FileType: SOURCE
# SPDX-License-Identifier: CC0-1.0

site_name: Pitloom
site_description: An SBOM generator for Python projects and AI models
site_url: https://bact.github.io/pitloom/
repo_url: https://github.com/bact/pitloom
repo_name: bact/pitloom
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2026-present Arthit Suriyawongkul

docs_dir: docs
watch:
  - src/pitloom

nav:
  - Home: index.md
  - Command line: cli.md
  - Wheel SBOMs (PEP 770): wheel-sbom.md
  - SBOM fragments: fragments.md
  - Loom ID registry: id-registry.md
  - Building a project (--allow-build): allow-build.md
  - AI model formats: ai-model-formats.md
  - AI model scan limits: ai-model-scan-limits.md
  - Python API:
      - Guide: python-api.md
      - API reference: api.md
  - Hatchling build hook: hatchling-build-hook.md
  - GitHub Action: github-action.md
  - Agent Skills: agent-skills.md
  - Claude Code plugin: claude-code-plugin.md
  - Reference:
      - Configuration: configuration.md
      - Dependency sources: dependency-sources.md
      - Creation metadata: creation-metadata.md
      - Metadata provenance: metadata-provenance.md
      - Resources: resources.md

theme:
  name: material
  logo: mascot.png
  favicon: mascot.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

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

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_section_style: table
            show_source: true
            show_root_heading: true
            show_root_full_path: true
            show_signature_annotations: true
            separate_signature: true
            merge_init_into_class: true
            show_bases: false
            heading_level: 3

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bact/pitloom
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pitloom/