documentation/mkdocs-developers.yml at main · mat3ra/documentation · 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# Developers — REST API reference and contribution guides.
# Deploy to: docs.mat3ra.com/developers/

INHERIT: mkdocs-base.yml

docs_dir: !!python/object/apply:os.getenv ["DOCS_DIR", "lang/en/docs"]

# Exclude pages that belong to other sites.
exclude_docs: |
  accounts/
  benchmarks/
  cli/
  collaboration/
  data/
  data-structured/
  data-in-objectstorage/
  data-on-disk/
  entities-general/
  getting-started/
  infrastructure/
  jobs/
  /jobs-cli/
  jobs-designer/
  jupyterlite/
  materials/
  materials-designer/
  methods/
  methods-directory/
  models/
  models-directory/
  other/
  pricing/
  properties/
  properties-directory/
  remote-connection/
  security/
  site-policy/
  software/
  software-directory/
  tutorials/
  ui/
  workflow-designer/
  workflows/
  migrating-to-new-platform.md

  # Other sites' homepages
  index.md
  index-guide.md
  index-interface.md
  index-concepts.md
  index-dev.md
  index-resources.md
  index-cli.md
  index-standards.md

  # Data Standards site pages
  models/data.md
  methods/data.md
  software/data.md
  models-directory/dft/data.md
  models-directory/machine-learning/data.md
  methods-directory/pseudopotential/data.md
  methods-directory/linear-regression/data.md
  materials/data.md
  jobs/data.md

validation:
  nav:
    omitted_files: info
    not_found: warn
  links:
    absolute_links: info

site_name: "Developers"
site_url: https://docs.mat3ra.com/developers
site_description: "REST API reference and contribution guides for the Mat3ra platform."
dev_addr: "localhost:8006"

theme:
  features:
    - announce.dismiss
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.top
    - search.highlight
    - search.suggest
    - navigation.expand

extra:
    # Cross-site URL variables (resolved by macros plugin at build time)
    guide_url: https://docs.mat3ra.com/guide
    interface_url: https://docs.mat3ra.com/interface
    reference_url: https://docs.mat3ra.com/reference
    resources_url: https://docs.mat3ra.com/resources
    developers_url: https://docs.mat3ra.com/developers
    cli_url: https://docs.mat3ra.com/command-line
    data_url: https://docs.mat3ra.com/standards


nav:
    - "← All Docs":                                      /
    - Home:                                              index-developers.md

# REST API
    - REST API:
        - Overview:                                    rest-api/overview.md
        - Authentication:                              rest-api/authentication.md
        - Query structure:                             rest-api/query-structure.md
        - Endpoints:                                   rest-api/endpoints.md
        - API Explorer:                                rest-api/api-explorer.md
        - API client:                          rest-api/api-client.md
        - API examples:                        rest-api/api-examples.md