Browse Source

Add doc8

master
Lucidiot 2 years ago
parent
commit
b668b0c2e6
No known key found for this signature in database GPG Key ID: AE3F7205692FA205
  1. 5
      .gitlab-ci.yml
  2. 9
      docs/contributing.rst
  3. 1
      requirements-dev.txt
  4. 3
      setup.cfg

5
.gitlab-ci.yml

@ -25,6 +25,11 @@ flake8:
script:
- flake8
doc8:
stage: test
script:
- doc8
deploy-pypi:
stage: deploy
when: manual

9
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

1
requirements-dev.txt

@ -1,4 +1,5 @@
flake8>=3.5
doc8>=0.8
Sphinx>=1.8.1
coverage>=4.5
codecov>=2.0

3
setup.cfg

@ -1,2 +1,5 @@
[flake8]
exclude = .git,__pycache__,docs,*.pyc,venv
[doc8]
ignore-path=**/*.txt,*.txt,*.egg-info,docs/_build,venv,.git

Loading…
Cancel
Save