blob: fd87fdce0d031d62ecaa60298f1f16fa85473257 [file] [log] [blame]
Joey Armstronga8205c22023-10-18 13:35:16 -04001[doc8]
2
Joey Armstronga8205c22023-10-18 13:35:16 -04003## -----------------------------------------------------------------------
4# $ doc8 -h
5#
6# usage: doc8 [-h] [--config path] [--allow-long-titles] [--ignore code]
7# [--no-sphinx] [--ignore-path path] [--ignore-path-errors path]
8# [--default-extension extension] [--file-encoding encoding]
9# [--max-line-length int] [-e extension] [-v] [--version]
10# [path [path ...]]
11#
12# Check documentation for simple style requirements.
13#
14# What is checked:
15# - invalid RST format - D000
16# - lines should not be longer than 79 characters - D001
17# - RST exception: line with no whitespace except in the beginning
18# - RST exception: lines with http or https urls
19# - RST exception: literal blocks
20# - RST exception: rst target directives
21# - no trailing whitespace - D002
22# - no tabulation for indentation - D003
23# - no carriage returns (use unix newlines) - D004
24# - no newline at end of file - D005
25#
26# positional arguments:
27# path Path to scan for doc files (default: current
28# directory).
29#
30# optional arguments:
31# -h, --help show this help message and exit
32# --config path user config file location (default: .config/doc8.ini, doc8.ini, tox.ini,
33# pep8.ini, setup.cfg).
34# --allow-long-titles allow long section titles (default: false).
35# --ignore code ignore the given error code(s).
36# --no-sphinx do not ignore sphinx specific false positives.
37# --ignore-path path ignore the given directory or file (globs are
38# supported).
39# --ignore-path-errors path
40# ignore the given specific errors in the provided file.
41# --default-extension extension
42# default file extension to use when a file is found
43# without a file extension.
44# --file-encoding encoding
45# set input files text encoding
46# --max-line-length int
47# maximum allowed line length (default: 79).
48# -e extension, --extension extension
49# check file extensions of the given type (default:
50# .rst, .txt).
51# -q, --quiet only print violations
52# -v, --verbose run in verbose mode.
53# --version show the version and exit.
54## -----------------------------------------------------------------------
55
56# verbose=1
57
58extension = rst, txt
59ignore-path = .venv, */.venv
60
61# ignore-path-errors=/tmp/other_thing.rst;D001;D002
62# voltha-helm-charts/voltha-infra/templates/NOTES.txt:12: D001 Line too long
63
64max-line-length = 120
65
66# [SEE ALSO]
67# -----------------------------------------------------------------------
68# https://doc8.readthedocs.io/en/latest/readme.html
69# -----------------------------------------------------------------------