ingestlib/mkdocs.yml at main · LangModule/ingestlib · 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
104
105
106
107
108
109
110
site_name: ingestlib
site_description: >-
  Self-hosted document intelligence for RAG — parse, classify, split, and
  extract from PDF/DOCX/PPTX and images into searchable, cited chunks,
  with an MCP server to serve your corpus to agents.
site_url: https://langmodule.github.io/ingestlib/
repo_url: https://github.com/LangModule/ingestlib
repo_name: LangModule/ingestlib
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.tabs.link
    - search.suggest
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: null   # plain prose docstrings, rendered as-is
            show_source: false
            show_root_heading: true
            members_order: source
            filters: ["!^_"]
            separate_signature: true
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true

nav:
  - Home: index.md
  - Get started:
      - Installation: get-started/installation.md
      - Quickstart: get-started/quickstart.md
      - What just happened: get-started/first-pipeline.md
  - Concepts:
      - The pipeline: concepts/pipeline.md
      - Provenance & citations: concepts/provenance.md
      - Configuration model: concepts/configuration.md
      - Providers: concepts/providers.md
      - Storage model: concepts/storage.md
  - How-to guides:
      - Documents:
          - Parse any format: how-to/parse-documents.md
          - Use parse results: how-to/parse-results.md
          - Extract structured data: how-to/extract.md
      - Content rules:
          - Your categories & sections: how-to/content-rules.md
      - Pipeline:
          - Ingest documents: how-to/ingest.md
          - Manage a corpus: how-to/manage-corpus.md
          - Retrieve & filter: how-to/retrieve.md
          - Build cited answers: how-to/cited-answers.md
          - Serve to agents (MCP): how-to/mcp-server.md
      - Setup:
          - Run fully local: how-to/local-stack.md
          - Connect a vector store: how-to/vector-stores.md
          - Choose an artifact store: how-to/artifact-stores.md
          - Switch AI providers: how-to/switch-providers.md
          - Async, notebooks & logging: how-to/async-and-logging.md
      - Troubleshooting: how-to/troubleshooting.md
  - Reference:
      - CLI: reference/cli.md
      - Configuration: reference/configuration.md
      - Operations API: reference/operations.md
      - Services API: reference/services.md
      - Storage API: reference/storage.md
      - Result models: reference/models.md
  - About:
      - Architecture: about/architecture.md
      - Limits & scope: about/limits.md