python-embed/mkdocs.yml at main · howtis/python-embed · 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
site_name: PythonEmbed
site_description: Run Python code from Java — embed CPython in JVM apps via subprocess & MessagePack. Full numpy/scipy/torch support.
site_url: https://howtis.github.io/python-embed
repo_url: https://github.com/howtis/python-embed
repo_name: howtis/python-embed

docs_dir: docs

site_author: howtis

copyright: Copyright &copy; 2026 howtis

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/howtis/python-embed

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  features:
    - navigation.sections
    - navigation.expand
    - search.highlight
    - content.code.copy

plugins:
  - social:
      cards_layout_options:
        font_family: Inter
  - search

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Installation: installation.md
  - Usage:
      - Basics: usage/basics.md
      - Pool: usage/pool.md
      - Object Handles: usage/handles.md
      - Callbacks: usage/callbacks.md
      - Streaming: usage/streaming.md
      - Batch Operations: usage/batch.md
  - Architecture: architecture.md
  - Spring Boot: spring-boot.md
  - Examples:
      - Overview: examples/index.md
      - Basic Eval: examples/basic-eval.md
      - Batch Operations: examples/batch-operations.md
      - Callback Bridge: examples/callback-bridge.md
      - Configuration: examples/configuration.md
      - Error Handling: examples/error-handling.md
      - Health Monitor: examples/health-monitor.md
      - Maven Example: examples/maven-example.md
      - Numpy Basic: examples/numpy-basic.md
      - Object Handle: examples/object-handle.md
      - Pandas Dataframe: examples/pandas-dataframe.md
      - Pool Async: examples/pool-async.md
      - Proxy Object: examples/proxy-object.md
      - Spring Boot Example: examples/spring-boot-example.md
      - Streaming: examples/streaming.md
  - API Reference:
      - PythonEmbed: api/python-embed.md
      - PythonEmbedPool: api/python-embed-pool.md
      - PythonValue: api/python-value.md
      - PythonHandle: api/python-handle.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - admonition
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html