earthaccess/mkdocs.yml at main · earthaccess-dev/earthaccess · 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
site_name: earthaccess
site_description: Client library for NASA Earthdata APIs
site_url: https://github.com/earthaccess-dev/earthaccess

# Fail on broken links
# Do not disable if the build fails! Fix the broken links :)
strict: true

theme:
  name: "material"
  logo: logo.png
  favicon: earth.png
  palette:
    - scheme: default
      primary: teal
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    # Allow navigation sections to link to index/overview pages.
    # See: https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
    - navigation.indexes
    # Enable navigation breadcrumbs
    - navigation.path
    # Display top-level nav elements in the top bar
    - navigation.tabs
    # Add "Edit this page" button
    - content.action.edit
    # Add "View source" buton
    - content.action.view

repo_name: "earthaccess-dev/earthaccess"
repo_url: "https://github.com/earthaccess-dev/earthaccess"
edit_uri: "edit/main/docs/"

extra_css:
  - css/styles.css

plugins:
  - search
  - awesome-nav
  - mermaid2
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: no
            merge_init_into_class: yes
            show_submodules: no
            show_root_heading: false
            show_source: false
  - autorefs
  - redirects:
      redirect_maps:
        "CODE_OF_CONDUCT.md": "contributor/code-of-conduct.md"
        "contributing/our-meet-ups.md": "calendar.md"
  - mkdocs-jupyter:
      execute: true
      execute_ignore:
        - "user/tutorials/SSL.ipynb"
        - "user/tutorials/dmrpp-virtualizarr.ipynb"
        - "user/tutorials/dask.ipynb"
        - "user/howto/edl.ipynb"
        - "user/howto/fsspec.ipynb"
      ignore:
        - "**/.ipynb_checkpoints/*"

markdown_extensions:
  - admonition
  - callouts
  - pymdownx.details
  - meta
  - md_in_html
  - toc:
      toc_depth: 2
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom

  - pymdownx.tabbed:
      alternate_style: true

watch:
  - docs
  - earthaccess