document-extraction-tools/mkdocs.yml at main · artefactory-uk/document-extraction-tools · 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
111
112
113
114
115
site_name: Document Extraction Tools
site_url: https://artefactory-uk.github.io/document-extraction-tools/
site_description: A modular, high-performance toolkit for building document extraction pipelines.
site_author: Artefact UK

repo_name: artefactory-uk/document-extraction-tools
repo_url: https://github.com/artefactory-uk/document-extraction-tools

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
            show_if_no_docstring: true
            members: true
            filters: ["!^_"]

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Concepts:
      - Overview: concepts/overview.md
      - Data Models: concepts/data-models.md
      - Pipeline Context: concepts/pipeline-context.md
      - Extraction Pipeline: concepts/extraction-pipeline.md
      - Evaluation Pipeline: concepts/evaluation-pipeline.md
      - Configuration: concepts/configuration.md
  - Guides:
      - Implementing Extraction: guides/implementing-extraction.md
      - Implementing Evaluation: guides/implementing-evaluation.md
      - Heterogeneous Documents: guides/heterogeneous-documents.md
      - Production Patterns: guides/production-patterns.md
  - Examples: examples.md
  - API Reference:
      - Base Classes: api/base-classes.md
      - Configuration: api/configuration.md
      - Types: api/types.md
  - Contributing: contributing.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/artefactory-uk/document-extraction-tools

copyright: Copyright &copy; 2025 Artefact UK