xgcm/mkdocs.yml at master · hdrake/xgcm · 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
site_name: xgcm
site_url: https://xgcm.readthedocs.io/
site_author: "xgcm developers"

repo_name: "xgcm/xgcm"
repo_url: "https://github.com/xgcm/xgcm"

theme:
  name: material
  logo: images/logo.png
  icon:
    repo: fontawesome/brands/github
  features:
    - search.suggest
    - search.highlight
    - navigation.expand
    - navigation.tracking
    - toc.follow
  palette:
    scheme: default
    primary: white

plugins:
  autorefs: {}
  execute:
    exclude:
      # TODO: Fix
      - 'transform.ipynb'
      - 'xgcm-examples/*'
  mkdocs-jupyter:
    include_source: true
    execute: false
    include: ["*.ipynb"]   # don't render helper scripts (scripts/*.py) as pages
    # grid_metrics.ipynb is executed and rendered by the `execute` plugin above;
    # mkdocs-jupyter must skip it to avoid double-wrapping the same .ipynb file.
    ignore:
      - 'grid_metrics.ipynb'
  mkdocstrings:
    handlers:
      python:
        paths: [.]
        inventories:
          - https://docs.python.org/3/objects.inv
          - https://docs.pydantic.dev/latest/objects.inv
        options:
          members_order: source
          separate_signature: true
          filters: ["!^_"]
          show_root_heading: true
          show_if_no_docstring: true
          show_signature_annotations: true
  search: {}
  # mkdocs-autoapi:
  #   autoapi_add_nav_entry: Reference

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Installation: installation.md
  - Simple Grids: grids.md
  - Grid Topology: grid_topology.md
  - Grid Metrics: grid_metrics.ipynb
  - Grid Ufuncs:
    - Concept of a Grid Ufunc: grid_ufuncs.md
    - Ufunc Examples: ufunc_examples.md
  - Boundary Conditions: boundary_conditions.md
  - Transform: transform.ipynb
  - Examples:
      - MITgcm: xgcm-examples/01_mitgcm.ipynb
      - NEMO: xgcm-examples/02_nemo_idealized.ipynb
      - MOM6: xgcm-examples/03_MOM6.ipynb
      - MITgcm ECCOv4: xgcm-examples/04_eccov4.ipynb
      - Tripolar north fold: xgcm-examples/05_tripolar_fold.ipynb
  - "What's New": whats-new.md
  - Contributor Guide: contributor_guide.md
  - API: api.md