File: mkdocs.yml

package info (click to toggle)
python-watchfiles 1.1.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 600 kB
  • sloc: python: 1,997; makefile: 86
file content (83 lines) | stat: -rw-r--r-- 1,995 bytes parent folder | download
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
site_name: watchfiles
site_description: Simple, modern and high performance file watching and code reload in python.
site_url: https://watchfiles.helpmanual.io

theme:
  name: material
  palette:
  - scheme: default
    primary: blue grey
    accent: indigo
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
  - scheme: slate
    primary: blue grey
    accent: indigo
    toggle:
      icon: material/lightbulb-outline
      name: Switch to light mode
  features:
  - search.suggest
  - search.highlight
  - content.tabs.link
  - content.code.annotate
  icon:
    repo: fontawesome/brands/github-alt
#  logo: img/logo-white.svg
#  favicon: img/favicon.png
  language: en

repo_name: samuelcolvin/watchfiles
repo_url: https://github.com/samuelcolvin/watchfiles
edit_uri: ''
nav:
  - Introduction: index.md
  - CLI: cli.md
  - 'Migration from watchgod': migrating.md
  - 'API Documentation':
    - api/watch.md
    - api/run_process.md
    - api/filters.md
    - api/rust_backend.md

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - md_in_html
  - mdx_include
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  social:
  - icon: fontawesome/brands/github-alt
    link: https://github.com/samuelcolvin/watchfiles
  - icon: fontawesome/brands/twitter
    link: https://twitter.com/samuel_colvin

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_root_full_path: false
            show_source: false
            heading_level: 2
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true

hooks:
  - 'docs/.hooks/main.py'