enroot-py/mkdocs.yml at main · Agent-One-Lab/enroot-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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
site_name: enroot-py
site_description: A Python client for Enroot containers
repo_url: https://github.com/Agent-One-Lab/enroot-py
docs_dir: docs

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: agl
      accent: agl
    - toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: agl
      accent: agl
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Quick Start:
      - Basic Usage: quick_start/basic_usage.md
      - API Usage Examples: quick_start/api_usage.md
      - Asynchronous Features: quick_start/async_features.md
  - API References:
      - EnrootClient: api_references/client.md
      - Container: api_references/container.md
      - Containers: api_references/containers.md
      - Images: api_references/images.md
      - Errors: api_references/errors.md
      - Utils: api_references/utils.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_section_style: list
            docstring_style: google
            heading_level: 3

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - tables
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji

extra_css:
  - stylesheets/extra.css