beeware-docs-tools/.pyspelling.yml at main · beeware/beeware-docs-tools · 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
matrix:
- name: markdown
  dictionary:
    wordlists:
    - docs/spelling_wordlist
    output: _build/dictionary/python.dic
  sources:
  - 'docs/**/*.md'
  - 'src/**/*.md'
  pipeline:
  - pyspelling.filters.markdown:
      markdown_extensions:
      - markdown.extensions.toc
      - markdown.extensions.admonition
      - markdown.extensions.attr_list
      - pymdownx.superfences
      - pymdownx.blocks.admonition
      - pymdownx.blocks.caption
      - pymdownx.blocks.tab
  - pyspelling.filters.html:
      comments: true
      attributes:
        - title
        - alt
      ignores:
        - 'code'
        - 'pre'
        - 'nospell'  # Allows for ignoring a word or words inline.
  - pyspelling.filters.context:
      context_visible_first: true
      escapes: '\\[\\`~]'
      delimiters:
        # Ignores the Jinja directives and their contents
        - open: '{%'
          content: '[\d\D]*'
          close: '%}'
        # Ignores the Jinja variables and their contents
        - open: '{{'
          content: '[\d\D]*'
          close: '}}'
        # Ignores the autorefs link targets
        - open: '\]\['
          content: '[\d\D]*'
          close: '\]'
        # Ignore the mkdocstrings calls
        - open: ':::'
          content: '[\d\D]*'
          close: '\n'
        # Ignore the single line Snippets syntax
        - open: '-8<\-'
          content: '[\d\D]*'
          close: '\n'
        # Ignore the multiline Snippets syntax
        - open: '-8<\-\n'
          content: '[\d\D]*'
          close: '-8<-\n'