openvc/mkdocs.yml at main · luisgf/openvc · 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
site_name: openvc
site_description: A dependency-light Verifiable Credentials core for Python
repo_url: https://github.com/luisgf/openvc
repo_name: luisgf/openvc
docs_dir: docs

# The site is the API reference only; the narrative manual lives on the GitHub
# wiki (sourced from wiki/ in this repo). Everything else under docs/ is repo
# material (ADRs, roadmap, conventions) or historical — not part of the site.
exclude_docs: |
  SESSION-HANDOFF.md
  CONVENTIONS.md
  ROADMAP.md
  adr/

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - toc.follow
  palette:
    - scheme: default
      primary: indigo
      toggle: { icon: material/weather-night, name: Dark mode }
    - scheme: slate
      primary: indigo
      toggle: { icon: material/weather-sunny, name: Light mode }

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_source: true
            members_order: source
            docstring_section_style: table
            filters: ["!^_"]

nav:
  - Home: index.md
  - API reference:
      - Verification pipeline: api/verification.md
      - Async verification: api/async.md
      - OpenID4VP presentations: api/openid4vp.md
      - ISO mdoc (mso_mdoc): api/mdoc.md
      - Proof suites: api/proofs.md
      - DIDs & keys: api/dids-keys.md
      - Status lists: api/status.md
      - Credential schema & type metadata: api/schema.md
      - EU Trusted Lists: api/trustlist.md
      - Issuer-key discovery: api/discovery.md
      - Observability: api/observability.md
      - Errors: api/errors.md