vlm4ocr/mkdocs.yml at main · daviden1013/vlm4ocr · 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
site_name: VLM4OCR Documentation
theme:
    name: material
    features:
      - content.code.highlight
repo_url: https://github.com/daviden1013/vlm4ocr
repo_name: daviden1013/vlm4ocr

nav:
    - 'Home': 'index.md'
    - 'Web Application': 'web_application.md'
    - 'CLI': 'cli.md'
    - 'Python package':
      - 'Quick Start': 'quick_start.md'
      - 'VLM Engines': 'vlm_engines.md'
      - 'OCR Engine': 'ocr_engines.md'
      - 'BBox Mode': 'bbox.md'
    - 'API Reference':
      - 'VLM Engines': 'api/vlm_engines.md'
      - 'OCR Engine': 'api/ocr_engines.md'
      - 'CLI': 'api/cli.md'

plugins:
    - search
    - gen-files:
        scripts:
          - docs/generate_cli_docs.py
    - mkdocs-video
    - mkdocstrings:
        handlers:
          python:
            options:
              preload_modules:
                - llm_inference_engine
              docstring_style: numpy
              show_root_heading: true
              show_source: true
              members_order: source
              separate_signature: true
              show_signature_annotations: true
              show_docstring_annotations: true
              merge_init_into_class: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences