Joey Armstrong | a8205c2 | 2023-10-18 13:35:16 -0400 | [diff] [blame] | 1 | [doc8] |
| 2 | |
Joey Armstrong | dc04c93 | 2024-04-01 12:14:21 -0400 | [diff] [blame] | 3 | # ----------------------------------------------------------------------- |
| 4 | # Copyright 2017-2024 Open Networking Foundation Contributors |
| 5 | # |
| 6 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | # you may not use this file except in compliance with the License. |
| 8 | # You may obtain a copy of the License at |
| 9 | # |
| 10 | # http:#www.apache.org/licenses/LICENSE-2.0 |
| 11 | # |
| 12 | # Unless required by applicable law or agreed to in writing, software |
| 13 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | # See the License for the specific language governing permissions and |
| 16 | # limitations under the License. |
| 17 | # ----------------------------------------------------------------------- |
| 18 | # SPDX-FileCopyrightText: 2017-2024 Open Networking Foundation Contributors |
| 19 | # SPDX-License-Identifier: Apache-2.0 |
| 20 | # ----------------------------------------------------------------------- |
| 21 | # Intent: |
| 22 | # ----------------------------------------------------------------------- |
| 23 | |
Joey Armstrong | a8205c2 | 2023-10-18 13:35:16 -0400 | [diff] [blame] | 24 | ## ----------------------------------------------------------------------- |
| 25 | # $ doc8 -h |
| 26 | # |
| 27 | # usage: doc8 [-h] [--config path] [--allow-long-titles] [--ignore code] |
| 28 | # [--no-sphinx] [--ignore-path path] [--ignore-path-errors path] |
| 29 | # [--default-extension extension] [--file-encoding encoding] |
| 30 | # [--max-line-length int] [-e extension] [-v] [--version] |
| 31 | # [path [path ...]] |
| 32 | # |
| 33 | # Check documentation for simple style requirements. |
| 34 | # |
| 35 | # What is checked: |
| 36 | # - invalid RST format - D000 |
| 37 | # - lines should not be longer than 79 characters - D001 |
| 38 | # - RST exception: line with no whitespace except in the beginning |
| 39 | # - RST exception: lines with http or https urls |
| 40 | # - RST exception: literal blocks |
| 41 | # - RST exception: rst target directives |
| 42 | # - no trailing whitespace - D002 |
| 43 | # - no tabulation for indentation - D003 |
| 44 | # - no carriage returns (use unix newlines) - D004 |
| 45 | # - no newline at end of file - D005 |
| 46 | # |
| 47 | # positional arguments: |
| 48 | # path Path to scan for doc files (default: current |
| 49 | # directory). |
| 50 | # |
| 51 | # optional arguments: |
| 52 | # -h, --help show this help message and exit |
| 53 | # --config path user config file location (default: .config/doc8.ini, doc8.ini, tox.ini, |
| 54 | # pep8.ini, setup.cfg). |
| 55 | # --allow-long-titles allow long section titles (default: false). |
| 56 | # --ignore code ignore the given error code(s). |
| 57 | # --no-sphinx do not ignore sphinx specific false positives. |
| 58 | # --ignore-path path ignore the given directory or file (globs are |
| 59 | # supported). |
| 60 | # --ignore-path-errors path |
| 61 | # ignore the given specific errors in the provided file. |
| 62 | # --default-extension extension |
| 63 | # default file extension to use when a file is found |
| 64 | # without a file extension. |
| 65 | # --file-encoding encoding |
| 66 | # set input files text encoding |
| 67 | # --max-line-length int |
| 68 | # maximum allowed line length (default: 79). |
| 69 | # -e extension, --extension extension |
| 70 | # check file extensions of the given type (default: |
| 71 | # .rst, .txt). |
| 72 | # -q, --quiet only print violations |
| 73 | # -v, --verbose run in verbose mode. |
| 74 | # --version show the version and exit. |
| 75 | ## ----------------------------------------------------------------------- |
| 76 | |
| 77 | # verbose=1 |
| 78 | |
| 79 | extension = rst, txt |
| 80 | ignore-path = .venv, */.venv |
| 81 | |
| 82 | # ignore-path-errors=/tmp/other_thing.rst;D001;D002 |
| 83 | # voltha-helm-charts/voltha-infra/templates/NOTES.txt:12: D001 Line too long |
| 84 | |
| 85 | max-line-length = 120 |
| 86 | |
| 87 | # [SEE ALSO] |
| 88 | # ----------------------------------------------------------------------- |
| 89 | # https://doc8.readthedocs.io/en/latest/readme.html |
| 90 | # ----------------------------------------------------------------------- |