orcapod-python/mkdocs.yml at main · nauticalab/orcapod-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
site_name: Orcapod
site_description: Intuitive and powerful library for highly reproducible scientific data pipelines
repo_url: https://github.com/walkerlab/orcapod-python

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.suggest
    - content.code.copy

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

markdown_extensions:
  - admonition
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Concepts:
    - Sources: concepts/sources.md
    - Streams: concepts/streams.md
    - Operators: concepts/operators.md
    - Function Pods: concepts/function-pods.md
    - Identity & Hashing: concepts/identity.md
  - API Reference:
    - Overview: api/index.md
    - Sources: api/sources.md
    - Streams: api/streams.md
    - Operators: api/operators.md
    - Function Pods: api/function-pods.md
    - Databases: api/databases.md
    - Nodes: api/nodes.md
    - Pipeline: api/pipeline.md
    - Types: api/types.md