protest/mkdocs.yml at main · renaudcepre/protest · 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
site_name: ProTest
site_description: Async-first testing with explicit dependency injection
repo_url: https://github.com/renaudcepre/protest
repo_name: renaudcepre/protest

theme:
  name: material
  logo: assets/icon.svg
  favicon: assets/icon.svg
  palette:
    - scheme: default
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.tabs.link
    - search.highlight

extra_css:
  - stylesheets/extra.css

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
      - Running Tests: getting-started/running-tests.md
  - Core Concepts:
      - Sessions & Suites: core-concepts/sessions-and-suites.md
      - Tests: core-concepts/tests.md
      - Fixtures: core-concepts/fixtures.md
      - Built-in Fixtures: core-concepts/builtins.md
      - Factories: core-concepts/factories.md
      - Parameterized Tests: core-concepts/parameterized-tests.md
      - Tags: core-concepts/tags.md
      - Dependency Injection: core-concepts/dependency-injection.md
      - Reporters: core-concepts/reporters.md
  - Guides:
      - Best Practices: best-practices.md
      - Project Organization: guides/project-organization.md
      - Testing FastAPI: guides/testing-fastapi.md
      - Migrating from pytest: guides/pytest-to-protest.md
  - CLI Reference: cli.md
  - FAQ: faq.md
  - Internals:
      - Architecture: internals/architecture.md
      - Events: internals/events.md
      - Event Bus: internals/event-bus.md
      - Filters: internals/filters.md
      - Dependency Injection: internals/dependency-injection.md
      - Plugins: internals/plugins.md