rebake/python/mkdocs.yml at main · airoa-org/rebake · 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
site_name: rebake
site_description: Python library for converting ROS bag files to ML-ready datasets
site_url: https://airoa-org.github.io/rebake-rs/

repo_name: rebake-rs
repo_url: https://github.com/airoa-org/rebake-rs

theme:
  name: material
  language: en
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.code.annotate

extra_css:
  - stylesheets/extra.css

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            # Headings
            show_root_heading: true
            show_root_toc_entry: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            # Members
            members_order: source
            group_by_category: true
            # Docstrings
            docstring_style: google
            docstring_section_style: spacy
            merge_init_into_class: true
            show_if_no_docstring: false
            # Signatures
            show_signature: true
            show_signature_annotations: true
            separate_signature: true
            line_length: 80
            # Source
            show_source: false

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - API Reference:
      - Overview: api/index.md
      - Analysis: api/analysis.md
      - Core: api/core.md
      - Ingest: api/ingest.md
      - Synchronize: api/synchronize.md
      - Enrich: api/enrich.md
      - Encode: api/encode.md
      - Decode: api/decode.md
      - Transform: api/transform.md
      - Pipeline: api/pipeline.md
      - Exceptions: api/exceptions.md