bank_statement_parser/mkdocs.yml at master · boscorat/bank_statement_parser · 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
site_name: Bank Statement Parser
site_description: Documentation for the bank_statement_parser Python library — parse bank statement PDFs, extract structured transaction data, and persist to Parquet and SQLite.
site_url: https://boscorat.github.io/bank_statement_parser/
repo_url: https://github.com/boscorat/bank_statement_parser
repo_name: boscorat/bank_statement_parser

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

plugins:
  - search

extra:
  version:
    provider: mike
  goatcounter_url: !ENV [GOATCOUNTER_URL, '']

nav:
  - Home: index.md
  - Quick Start: guides/quick-start.md
  - Releases: https://github.com/boscorat/bank_statement_parser/releases
  - Contributing:
      - Adding a New Bank: guides/contributing-new-bank.md
      - Local Testing: guides/local-testing.md
      - Test Data Submission: guides/test-data-submission.md
  - Guides:
      - New Bank Config Reference: guides/new-bank-config.md
      - Anonymisation: guides/anonymisation.md
      - Project Structure: guides/project-structure.md
      - Export Options: guides/exports.md
  - Reference:
      - CLI: reference/cli.md
      - Python API: reference/python-api.md