Add doc8
This commit is contained in:
parent
06a329274d
commit
b668b0c2e6
|
@ -25,6 +25,11 @@ flake8:
|
|||
script:
|
||||
- flake8
|
||||
|
||||
doc8:
|
||||
stage: test
|
||||
script:
|
||||
- doc8
|
||||
|
||||
deploy-pypi:
|
||||
stage: deploy
|
||||
when: manual
|
||||
|
|
|
@ -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,4 +1,5 @@
|
|||
flake8>=3.5
|
||||
doc8>=0.8
|
||||
Sphinx>=1.8.1
|
||||
coverage>=4.5
|
||||
codecov>=2.0
|
||||
|
|
Reference in New Issue