iris-service-python/mkdocs.yml at main · iris7-app/iris-service-python · 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
# MkDocs config — Python project documentation site
#
# Mirror of Java's compodoc (Angular UI) + javadoc (svc) — generates a
# searchable static site combining narrative docs (under docs/) +
# auto-generated API reference from Python docstrings via mkdocstrings.
#
# Build :
#   uv run mkdocs build           → static site at site/
#   uv run mkdocs serve           → live-reload preview at :8000
#
# CI publishes to GitLab Pages on every main push (.gitlab-ci/docs.yml).
# Reachable at https://iris-7.gitlab.io/iris-service-python/

site_name: Iris Service Python
site_description: Python mirror of iris-service Java backend (FastAPI + Pydantic v2 + SQLAlchemy 2.x async)
site_url: https://iris-7.gitlab.io/iris-service-python/
repo_url: https://gitlab.com/iris-7/iris-service-python
repo_name: iris-7/iris-service-python
edit_uri: edit/dev/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/gitlab

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_signature_annotations: true
            show_root_heading: true
            members_order: source
            docstring_style: google
            merge_init_into_class: true
            heading_level: 2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Architecture:
    - Overview: architecture/overview.md
    - ADRs: architecture/adrs.md
  - Operations:
    - Alembic migrations: operations/alembic.md
  - API Reference:
    - app: reference/app.md
    - auth: reference/auth.md
    - customer: reference/customer.md
    - messaging: reference/messaging.md
    - middleware: reference/middleware.md
    - observability: reference/observability.md
    - integration: reference/integration.md