From b668b0c2e6addc2d18d9a1589a2128b0cf84fac3 Mon Sep 17 00:00:00 2001 From: Lucidiot Date: Sat, 6 Jul 2019 20:20:35 +0200 Subject: [PATCH] Add doc8 --- .gitlab-ci.yml | 5 +++++ docs/contributing.rst | 9 +++++---- requirements-dev.txt | 1 + setup.cfg | 3 +++ 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index cb9027f..12beb4b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -25,6 +25,11 @@ flake8: script: - flake8 +doc8: + stage: test + script: + - doc8 + deploy-pypi: stage: deploy when: manual diff --git a/docs/contributing.rst b/docs/contributing.rst index 6a420b1..a071954 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,7 +1,7 @@ Contributing ============ -Contributions to the project are greatly appreciated. +Contributions to the project are greatly appreciated. Bugs and suggestions -------------------- @@ -27,9 +27,9 @@ recommended:: mkvirtualenv -a . pyurbantz pip install -e .[dev] -This will clone the repository, create a virtual environment named ``pyurbantz``, -then tell pip to let the package be editable (``-e``). The ``[dev]`` suffix adds -the extra requirements useful for development. +This will clone the repository, create a virtual environment named +``pyurbantz``, then tell pip to let the package be editable (``-e``). +The ``[dev]`` suffix adds the extra requirements useful for development. Linting ^^^^^^^ @@ -45,6 +45,7 @@ The documentation you are reading is generated by the `Sphinx`_ tool. The text files that hold the documentation's contents are written in `reStructuredText`_ and are available under the ``/docs`` folder of the `GitLab repository`_. +They are also subject to linting using the ``doc8`` tool. .. _submit an issue: https://gitlab.com/Lucidiot/pyurbantz/issues/new .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io diff --git a/requirements-dev.txt b/requirements-dev.txt index 7d63c2a..c39c142 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -1,4 +1,5 @@ flake8>=3.5 +doc8>=0.8 Sphinx>=1.8.1 coverage>=4.5 codecov>=2.0 diff --git a/setup.cfg b/setup.cfg index df20b75..b963157 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,2 +1,5 @@ [flake8] exclude = .git,__pycache__,docs,*.pyc,venv + +[doc8] +ignore-path=**/*.txt,*.txt,*.egg-info,docs/_build,venv,.git