ca-biositing/mkdocs.yml at main · petercarbsmith/ca-biositing · 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
site_name: CA-BioSiting
repo_url: https://github.com/sustainability-software-lab/ca-biositing

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

extra_css:
  - stylesheets/api-reference.css

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true
  - awesome-pages
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src/ca_biositing/datamodels
            - src/ca_biositing/pipeline
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            heading_level: 2
            show_category_heading: true
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.inlinehilite
  - pymdownx.emoji

nav:
  - Home: README.md
  - Architecture: architecture.md
  - Local Setup: ca_biositing_local_setup.md
  - Notebook Setup: notebook_setup.md
  - Pipeline:
      - Overview: pipeline/README.md
      - ETL Workflow: pipeline/ETL_WORKFLOW.md
      - Alembic Workflow: pipeline/ALEMBIC_WORKFLOW.md
      - Docker Workflow: pipeline/DOCKER_WORKFLOW.md
      - Prefect Workflow: pipeline/PREFECT_WORKFLOW.md
      - GCP Setup: pipeline/GCP_SETUP.md
      - USDA ETL Guide: pipeline/USDA/USDA_ETL_GUIDE.md
      - Contributing: pipeline/CONTRIBUTING.md
  - Datamodels:
      - Overview: datamodels/README.md
      - SQL-First Workflow: datamodels/SQL_FIRST_WORKFLOW.md
      - Contributing: datamodels/CONTRIBUTING.md
  - Webservice:
      - Overview: webservice/README.md
      - Contributing: webservice/CONTRIBUTING.md
  - Resources:
      - Overview: resources/README.md
  - API Reference:
      - Overview: api/index.md
      - Datamodels: api/datamodels.md
      - Pipeline: api/pipeline.md
  - Deployment: deployment/README.md
  - Contributing: CONTRIBUTING.md
  - Code of Conduct: CODE_OF_CONDUCT.md
  - ERD View: ERD_VIEW.md