common/vale.ini at main · readthedocs/common · 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
StylesPath = docs/vale/
MinAlertLevel = suggestion

[*.rst]

BasedOnStyles = Vale, RTD, proselint, TheEconomist

# Enable more Vale rules
Vale.Repetition = YES
Vale.Spelling = NO  # Using custom RTD.CustomSpelling instead
Vale.Terms = YES
Vale.Avoid = YES
Vale.Conditionals = YES
Vale.ReadabilityAutomatedReadability = YES
Vale.ReadabilityFleschKincaid = YES
Vale.ReadabilityFleschReading = YES
Vale.ReadabilityGunningFog = YES

# Use custom spelling that excludes technical terms
RTD.CustomSpelling = YES

# Enable more proselint rules for stricter checking
proselint.Very = NO
proselint.But = NO
proselint.Typography = NO
proselint.Cliches = YES
proselint.Hedging = YES
proselint.Jargon = YES
proselint.Needless = YES
proselint.Archaisms = YES
proselint.CorporateSpeak = YES
proselint.Hyperbole = YES

# Enable TheEconomist rules
TheEconomist.UnnecessaryWords = YES
TheEconomist.Hectoring = YES


; Ignores are a bit janky, do this for now..

[CHANGELOG.rst]
BasedOnStyles =

[docs/dev/*.rst]
BasedOnStyles =