data-ingestion/mkdocs.yml at main · transitmatters/data-ingestion · 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
site_name: Data Ingestion
site_description: Automated data crunching jobs by TransitMatters
site_url: https://transitmatters.github.io/data-ingestion
repo_url: https://github.com/transitmatters/data-ingestion
repo_name: transitmatters/data-ingestion

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.sections
    - navigation.expand
    - toc.follow

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - toc:
      permalink: true

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            members_order: source
            docstring_style: google

nav:
  - Home: index.md
  - API Reference:
      - GTFS:
          - Overview: api/gtfs/gtfs.md
          - Utils: api/gtfs/utils.md
          - Ingest: api/gtfs/ingest.md
          - Enqueue: api/gtfs/enqueue.md
      - Service Ridership Dashboard:
          - GTFS: api/service_ridership_dashboard/gtfs.md
          - Ingest: api/service_ridership_dashboard/ingest.md
          - Queries: api/service_ridership_dashboard/queries.md
          - Ridership: api/service_ridership_dashboard/ridership.md
          - S3: api/service_ridership_dashboard/s3.md
          - Service Levels: api/service_ridership_dashboard/service_levels.md
          - Service Summaries: api/service_ridership_dashboard/service_summaries.md
          - Summary: api/service_ridership_dashboard/summary.md
          - Time Series: api/service_ridership_dashboard/time_series.md