Browse Source

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
changes/81/653681/1
Masayuki Igawa 3 years ago
parent
commit
85216dc2fb
No known key found for this signature in database
GPG Key ID: 290F53EDC899BF89
  1. 6
      README.rst
  2. 6
      doc/source/user/index.rst
  3. 1
      test-requirements.txt

6
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
----

6
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
----------------

1
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

Loading…
Cancel
Save