CDIPpy/mkdocs.yml at main · UCSD-SIO-CDIP/CDIPpy · 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
site_name: CDIPpy Docs

# theme:
#   name: material

markdown_extensions:
  - attr_list

plugins:
  - macros
  - search
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            heading_level: 2
            show_root_heading: true
            show_signature_annotations: true
            docstring_style: google

theme:
  name: readthedocs

nav:
  - Home: index.md
  - Quick start: quickstart.md
  - API reference: api.md
  - Users guide:
    - Installation: user_guide/index.md
    - Data access: user_guide/data_access.md
    - Data visualization: user_guide/plotting.md
  - Developers guide:
    - Installation: dev_guide/index.md
    - Contributing: dev_guide/contribute.md
  - Examples: examples/index.md