ocpi-python/mkdocs.yml at main · elumobility/ocpi-python · 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
site_name: OCPI Python
site_description: A modern Python implementation of the Open Charge Point Interface (OCPI) protocol
site_author: ELU Mobility
site_url: https://elumobility.github.io/ocpi-python/

repo_name: elumobility/ocpi-python
repo_url: https://github.com/elumobility/ocpi-python
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2026 ELU Mobility

theme:
  name: material
  logo: assets/images/logo.png
  favicon: assets/images/logo.png
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: 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
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [ocpi]
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_root_full_path: false
            show_object_full_path: false
            show_category_heading: true
            show_if_no_docstring: false
            separate_signature: true
            line_length: 88

nav:
  - Home: index.md
  - Installation: installation.md
  - Quick Start: quickstart.md
  - LLM Assistance: llm-assistance.md
  - Tutorials:
    - Tutorials Overview: tutorials/index.md
    - Managing Locations: tutorials/locations.md
    - Handling Sessions: tutorials/sessions.md
    - Token Authorization: tutorials/tokens.md
    - CDR Generation: tutorials/cdrs.md
    - Commands: tutorials/commands.md
    - Charging Profiles: tutorials/charging_profiles.md
    - Booking Reservations: tutorials/bookings.md
    - CRUD Operations: tutorials/crud.md
    - Database Interface: tutorials/db_interface.md
    - Push Notifications: tutorials/push.md
  - API Reference:
    - API Overview: api/index.md
    - OCPI 2.3.0: api/v_2_3_0.md
    - OCPI 2.2.1: api/v_2_2_1.md
    - OCPI 2.1.1: api/v_2_1_1.md
  - Standards:
    - Standards Overview: standards/index.md
    - Coding Standards: standards/coding-standards.md
    - Development Workflow: standards/development-workflow.md
    - OCPI Compliance: standards/ocpi-compliance.md
  - Contributing: contributing.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/elumobility/ocpi-python
  version:
    provider: mike