From 85216dc2fb8bd5335bf801df0b30af35f72e18dd Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Thu, 18 Apr 2019 16:34:13 +0900 Subject: [PATCH] Introduce doc8 This commit introduces doc8 package to sanity the documents. As a result, one minor doc8 violations were found and fixed. Change-Id: I0e9d6212536e59e438a14f632c4fc6016c31cc60 --- README.rst | 6 +++--- doc/source/user/index.rst | 6 +++--- test-requirements.txt | 1 + 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 3e5a304..1f34c42 100644 --- a/README.rst +++ b/README.rst @@ -57,9 +57,9 @@ There are several options for running coverage2sql, they can be listed with:: coverage2sql --help -The only required option is ``--database-connection``. The options can either be -used on the CLI, or put in a config file. If a config file is used you need to -specify the location on the CLI. +The only required option is ``--database-connection``. The options can either +be used on the CLI, or put in a config file. If a config file is used you need +to specify the location on the CLI. TODO ---- diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 00f53a8..bc9347d 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -33,9 +33,9 @@ There are several options for running coverage2sql, they can be listed with:: coverage2sql --help -The only required option is ``--database-connection``. The options can either be -used on the CLI, or put in a config file. If a config file is used you need to -specify the location on the CLI. +The only required option is ``--database-connection``. The options can either +be used on the CLI, or put in a config file. If a config file is used you need +to specify the location on the CLI. Using in project ---------------- diff --git a/test-requirements.txt b/test-requirements.txt index 9afd64a..acf2fb2 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,6 +5,7 @@ hacking<0.11,>=0.10.0 docutils>=0.11 # OSI-Approved Open Source, Public Domain +doc8>=0.6.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD python-subunit>=0.0.18 # Apache-2.0/BSD sphinx>=1.6.2 # BSD