gradual/mkdocs.yml at main · Gradual-Load-Testing/gradual · 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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
site_name: Gradual - Stress Testing Framework
site_description: A comprehensive Python stress testing framework for applications and systems
site_author: Gradual Load Testing Team
site_url: https://gradual-load-testing.github.io/gradual

repo_name: Gradual-Load-Testing/gradual
repo_url: https://github.com/Gradual-Load-Testing/gradual
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.tabs.remember
    - content.tabs.tabs
    - content.tabs.tabs.sticky
    - content.tabs.tabs.sticky.primary
    - content.tabs.tabs.sticky.secondary
    - content.tabs.tabs.sticky.tertiary
    - content.tabs.tabs.sticky.quaternary
    - content.tabs.tabs.sticky.quinary
    - content.tabs.tabs.sticky.senary
    - content.tabs.tabs.sticky.septenary
    - content.tabs.tabs.sticky.octonary
    - content.tabs.tabs.sticky.nonary
    - content.tabs.tabs.sticky.denary
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_signature_annotations: true
            show_category_heading: true
            heading_level: 2
            members_order: source
            docstring_style: google
            preload_modules: [gradual]
            filters: ["!^_"]
  # - mermaid  # Using Material theme's built-in Mermaid support instead

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid

  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Getting Started: getting_started.md
  - User Guide:
      - User Guide: user_guide.md
      - Configuration: configuration_reference.md
  - Development Guide: dev_guide.md
  - API Reference:
      - Overview: api/overview.md
      - Core Modules:
          - Base Classes: api/base.md
          - Configuration: api/configs.md
          - Constants: api/constants.md
          - Exceptions: api/exceptions.md
          - Reporting: api/reporting.md
          - Runners: api/runners.md
      - Configuration:
          - Parser: api/parser.md
          - Phase: api/phase.md
          - Request: api/request.md
          - Scenario: api/scenario.md
          - Validation: api/validate.md
      - Base:
          - Orchestrator: api/orchestrator.md
      - Constants:
          - Request Types: api/request_types.md
      - Reporting:
          - Adapters: api/adapters.md
          - Logger: api/logger.md
          - Statistics: api/stats.md
          - Base Adapters: api/base.md
          - Logging Adapters: api/logging.md
      - Runners:
          - Iterators: api/iterators.md
          - Phase Runner: api/phase.md
          - Request Runner: api/request.md
          - Main Runner: api/runner.md
          - Scenario Runner: api/scenario.md
          - Session: api/session.md
          - HTTP Request: api/Http.md
          - SocketIO Request: api/SocketIO.md
          - Base Request: api/base.md
  - Examples: examples.md
  - Contributing: contributing.md

# extra:
#   social:
#     - icon: fontawesome/brands/github
#       link: https://github.com/Gradual-Load-Testing/gradual
#     - icon: fontawesome/brands/twitter
#       link: https://twitter.com/gradual_testing
#   analytics:
#     provider: google
#     property: !ENV GOOGLE_ANALYTICS_KEY
#   version:
#     provider: mike

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - https://polyfill.io/v3/polyfill.min.js?features=es6