data-to-science/mkdocs.yml at main · gdslab/data-to-science · 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
site_name: Data to Science (D2S)
site_description: Documentation for the Data to Science platform
site_url: https://gdslab.github.io/data-to-science/
repo_url: https://github.com/gdslab/data-to-science
repo_name: gdslab/data-to-science

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - toc.follow
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
      primary: custom
      accent: purple
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
      primary: custom
      accent: lime

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list

exclude_docs: |
  README.md
  paper.md
  paper.bib

nav:
  - Home: index.md
  - Tutorials:
      - tutorials/index.md
      - Getting Started: tutorials/quickstart.md
  - How-To Guides:
      - how-to/index.md
      - Local Development Setup: how-to/local-development.md
      - Deploy to Production: how-to/deployment.md
      - Run the Test Suite: how-to/run-tests.md
      - Manage Database Migrations: how-to/manage-migrations.md
      - Add an API Endpoint: how-to/add-api-endpoint.md
      - Work with Celery Tasks: how-to/celery-tasks.md
      - Generate Vector Format Files: how-to/generate-vector-formats.md
      - Backfill File Sizes: how-to/backfill-file-sizes.md
  - Reference:
      - reference/index.md
      - API: reference/api.md
      - Configuration: reference/configuration.md
      - Backend Structure: reference/backend-structure.md
      - Data Models: reference/data-models.md
      - Roles and Permissions: reference/roles-permissions.md
  - Explanation:
      - explanation/index.md
      - Architecture: explanation/architecture.md
      - Data Pipeline: explanation/data-pipeline.md
      - Authentication and Authorization: explanation/authentication.md
      - Tile Serving: explanation/tile-serving.md