AIOD-rest-api/mkdocs.yaml at develop · aiondemand/AIOD-rest-api · 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
site_name: AI-on-Demand REST API
site_url: https://api.aiod.eu/docs
repo_url: https://github.com/aiondemand/AIOD-rest-api
edit_uri: edit/develop/docs/
theme:
  name: material
  logo: media/secondary-neg-white-25p.webp
  features:
    - content.code.copy
    - navigation.footer
    - content.action.view
    - content.action.edit
    - content.footer.last-updated
  icon:
    edit: material/pencil
    view: material/eye
  font:
    text: 'Montserrat'
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - stylesheets/extra.css


nav:
  - Home: README.md
  - Using the API:
      - using/index.md
      - 'Uploading Metadata': using/upload.md
      - 'Migration v1 to v2': using/migration-v1-v2.md
  - Hosting the API:
      - hosting/index.md
      - 'Authentication': hosting/authentication.md
      - 'Connectors': hosting/connectors.md
      - 'Synchronization': hosting/synchronization.md
      - 'Monitoring': hosting/metrics.md
      - 'Proxies': hosting/proxy.md
  - 'Developer Resources':
      - developer/index.md
      - 'Authentication': developer/authentication.md
      - 'User Model': developer/users.md
      - 'Metadata Schema':
          - developer/schema/index.md
          - 'Versioning': developer/schema/versioning.md
          - 'Attributes': developer/schema/attributes.md
          - 'Relationships': developer/schema/relationships.md
          - 'Objects': developer/schema/objects.md
          - 'Schema Migration': developer/schema/migration.md
          - 'Taxonomies': developer/schema/taxonomies.md
      - 'Elastic Search': developer/elastic_search.md
      - 'Scripts': developer/scripts.md
      - 'Release Workflow': developer/releases.md
      - 'Troubleshooting': developer/troubleshooting.md
  - 'Contributing': contributing.md

markdown_extensions:
  - pymdownx.snippets:
      check_paths: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - section-index
  - search
  - git-revision-date-localized:
      type: datetime
      fallback_to_build_date: true
      locale: en
      timezone: UTC
      enable_creation_date: false