CDDS/mkdocs.yml at main · MetOffice/CDDS · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
site_name: Climate Data Dissemination System
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.expand
    - content.tabs.link
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
nav:
  - Home:
    - About: index.md
    - Changelog (CDDS): changes_cdds.md
    - Changelog (MIP Convert): changes_mip_convert.md
    - CMIP7 operational procedure: operational_procedure/cmip7.md
  - Operational Procedures:
    - operational_procedure/index.md
    - CMIP7: operational_procedure/cmip7.md
    - CMIP6 and CMIP6Plus: operational_procedure/cmip6.md
    - GCModelDev:
      -  operational_procedure/gcmodeldev.md
      - GCModelDev HadGEM3-GC31-LL Request: operational_procedure/gcmodeldev_examples/HadGEM3-GC31-LL.md
      - GCModelDev HadGEM3-GC31-LL ensemble class Request: operational_procedure/gcmodeldev_examples/HadGEM3-GC31-LL_envs.md
      - GCModelDev HadGEM3-GC31-MM Request: operational_procedure/gcmodeldev_examples/HadGEM3-GC31-MM.md
      - GCModelDev UKESM1-0-LL Request: operational_procedure/gcmodeldev_examples/UKESM1-0-LL.md
    - Simulation Review Procedure: operational_procedure/sim_review.md
    - Common Issues: operational_procedure/common_issues.md
  - Tutorials:
    - Quickstart: tutorials/quickstart.md
    - Search Inventory: tutorials/search_inventory.md
    - Add a Variable Mapping: tutorials/add_mapping.md
    - Add a Mapping Plugin: tutorials/add_mapping_plugin.md
    - Add a Plugin: tutorials/add_plugin.md
    - MIP Convert User Guide: tutorials/mip_convert.md
    - Request Configuration:
      -  tutorials/request/config_request.md
      - Inheritance Section: tutorials/request/inheritance.md
      - Metadata Section: tutorials/request/metadata.md
      - Common Section: tutorials/request/common.md
      - Data Section: tutorials/request/data.md
      - Inventory Section: tutorials/request/inventory.md
      - Conversion Section: tutorials/request/conversion.md
      - Global Attributes Section: tutorials/request/global_attributes.md
      - Misc Section: tutorials/request/misc.md
    - Model Parameters JSON File:
      -  tutorials/json_model_parameter.md
    - Mass Data Retrieval: tutorials/mass_data_retrieval.md
  - Developer Documentation:
    - developer_documentation/developer_documentation.md
    - Deployment:
      - Release Procedure: developer_documentation/deployment/release_procedure.md
      - Installation: developer_documentation/deployment/cdds_installation.md
      - Infrastructure: developer_documentation/deployment/infrastructure.md
    - Development Practices:
      - Coding Guidelines: developer_documentation/coding_guidelines.md
      - Development Workflow: developer_documentation/development_workflow.md
      - Review Process: developer_documentation/review_process.md
      - Managing Conda Environments: developer_documentation/managing_environments.md
      - Documentation: developer_documentation/documentation_practices.md
    - Request:
        - Request Architecture: developer_documentation/request/request.md
    - Testing:
      - Unit Testing: developer_documentation/unittests.md
      - Pytest: developer_documentation/pytest.md
      - Nightly Tests: developer_documentation/nightly_tests.md
      - Mip Convert Functional Tests: developer_documentation/mip_convert_functional_tests.md
    - Mapping Plugins:
        - Available Plugins: developer_documentation/mapping_plugins/available_mapping_plugins.md
        - Mapping Plugin Framework: developer_documentation/mapping_plugins/mapping_plugin_framework.md
    - Plugins:
        - Available Plugins: developer_documentation/plugins/available_plugins.md
        - Plugin Framework: developer_documentation/plugins/plugin_framework.md
  - Subpackages:
    - subpackages/index.md
    - cdds.convert: subpackages/convert.md
    - cdds.extract: subpackages/extract.md
    - cdds.qc: subpackages/qc.md
    - cdds.sim_review: subpackages/sim_review.md
    - cdds.transfer: subpackages/transfer.md
  - Mappings: mappings/index.md
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - pymdownx.details
  - footnotes
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji
  - pymdownx.details
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.tabbed:
      alternate_style: true
extra:
  version:
    provider: mike
plugins:
- search
- gen-files:
    scripts:
    - scripts/changes.py
    - scripts/mappings.py
- literate-nav:
    nav_file: SUMMARY.md
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: sphinx
- section-index