chainmock/mkdocs.yml at main · ollipa/chainmock · 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
site_name: Chainmock docs
site_description: chainmock - Mocking library for Python and Pytest
site_url: https://chainmock.readthedocs.io/en/latest/
theme:
  name: material
  logo: assets/icon_white.png
  favicon: assets/icon_black.png
  features:
    - content.code.annotate
    - navigation.expand
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
extra_css:
  - assets/extra.css
repo_name: chainmock
repo_url: https://github.com/ollipa/chainmock
edit_uri: ""
watch:
  - README.md
  - CONTRIBUTING.md
  - CHANGELOG.md
hooks:
  - docs/hooks/hide_lines.py

nav:
  - Overview: index.md
  - User Guide:
      - Getting started: user_guide/getting_started.md
      - Mocking: user_guide/mocking.md
      - Spying: user_guide/spying.md
      - Stubs: user_guide/stubs.md
      - Patching: user_guide/patching.md
      - Argument matching: user_guide/argument_matching.md
      - Async mocking: user_guide/async_mocking.md
      - Mocking properties: user_guide/mocking_properties.md
      - Mocking modules: user_guide/mocking_modules.md
      - Advanced usage: user_guide/advanced_usage.md
  - Comparison with unittest: unittest_comparison.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - API reference: api_reference.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            filters:
              - "!^_" # exlude all members starting with _
            show_source: false
            show_root_heading: true
            show_root_full_path: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets
  - markdown_include.include:
      base_path: docs