beacon-py/mkdocs.yml at main · maris-development/beacon-py · 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: Beacon Data Lake API Docs
theme:
    name: material
    features:
        - navigation.expand
        - content.code.copy
        - content.code.annotate
        - search.share
    palette:
        # Palette toggle for light mode
        - scheme: default
          toggle:
              icon: material/brightness-7
              name: Switch to dark mode

        # Palette toggle for dark mode
        - scheme: slate
          toggle:
              icon: material/brightness-4
              name: Switch to light mode

repo_url: https://github.com/maris-development/beacon-py
plugins:
    - search
    - mike:
          # These fields are all optional; the defaults are as below...
          alias_type: symlink
          redirect_template: null
          deploy_prefix: ""
          canonical_version: latest
          version_selector: true
          css_dir: css
          javascript_dir: js
    - mkdocstrings:
          handlers:
              python:
                  paths: ["."] # make MkDocs see your local package
                  options:
                      docstring_style: numpy
extra:
    version:
        provider: mike
        default: latest

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

nav:
    - Home: index.md
    - Installation: installation.md
    - Getting Started: getting_started.md
    - Using The Data Lake:
          - Exploring: using/exploring.md
          - Querying: using/querying.md
          - Tables (*collections): using/tables.md
          - Datasets: using/datasets.md
    - Examples:
          - World Ocean Database: examples/wod.md
    - API Reference:
          - Client: reference/client.md
          - Query: reference/query.md
          - Dataset: reference/dataset.md
          - Functions: reference/functions.md
          - Table: reference/table.md
    - Changelog: changelog.md
    - Beacon Data Lake: https://maris-development.github.io/beacon/