gsp-py/mkdocs.yml at master · jacksonpradolima/gsp-py · 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
site_name: GSP-Py
site_description: Documentation for the GSP-Py library
site_url: https://jacksonpradolima.github.io/gsp-py/
repo_url: https://github.com/jacksonpradolima/gsp-py
repo_name: jacksonpradolima/gsp-py
nav:
  - Home: index.md
  - Usage: usage.md
  - CLI: cli.md
  - API: api.md
  - Interactive Examples: examples.md
  - Logging & Verbosity: logging.md
  - Acceleration: acceleration.md
  - Benchmarks: benchmarks.md
  - Contributing: contributing.md
  - Typing: typing.md
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.instant
    - content.code.copy
    - content.tabs.link
plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: numpy
            show_root_heading: true
            heading_level: 2
            separate_signature: true
            show_source: false
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jacksonpradolima/gsp-py
markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - toc:
      permalink: true