gportal-python/mkdocs.yml at main · sankichi92/gportal-python · 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: gportal-python
site_description: Python client for JAXA G-Portal Catalogue Service and SFTP.
site_author: Takahiro Miyoshi

repo_url: https://github.com/sankichi92/gportal-python
repo_name: sankichi92/gportal-python

watch:
  - gportal
  - README.md

nav:
  - index.md
  - Examples:
      - examples/basic.ipynb
      - examples/geopandas.ipynb
      - examples/gcomc.ipynb
  - API Reference:
      - dataset: api/dataset.md
      - search: api/search.md
      - product: api/product.md
      - sftp: api/sftp.md
      - file: api/file.md

theme:
  name: material
  palette:
    # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/?h=palette#system-preference
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.footer
    - toc.integrate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.paramiko.org/en/3.1/objects.inv
            - https://docs.h5py.org/en/3.8.0/objects.inv
          options:
            heading_level: 1
            show_root_heading: true
            show_root_toc_entry: false
            group_by_category: false
            members_order: source
  - mkdocs-jupyter

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.magiclink
  # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#configuration
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.snippets
  - pymdownx.superfences