openstack/designate
Code Issues Proposed changes

Allow to check pep8 along with D000

Browse Source 
This patch only setup package dependency which named Pygments
for this test. Pygments also exist item in lower-contraints.txt
which does not setup along with tox env.

Change-Id: I1a75150b7fd813a4126716b898a55f35c64c5ec6
This commit is contained in:
Nguyen Van Trung 2018-05-10 10:08:06 +07:00
parent 2ac404cde3
commit 063fb8661b
7 changed files with 16 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -28,9 +28,9 @@ Setup
Setup a working environment: Setup a working environment:
.. code-block:: shell .. code-block:: bash
git clone https://github.com/openstack/designate.git git clone https://git.openstack.org/openstack/designate
cd designate cd designate
virtualenv .venv virtualenv .venv
. .venv/bin/activate . .venv/bin/activate
@ -42,7 +42,7 @@ Building Docs
To build the documentation from the restructured text source, do the following: To build the documentation from the restructured text source, do the following:
.. code-block:: shell .. code-block:: bash
cd doc cd doc
pip install -r requirements.txt pip install -r requirements.txt

8
doc/source/install/install-obs.rst
View File

@ -43,9 +43,7 @@ Install and configure components
# zypper install bind bind-utils # zypper install bind bind-utils
#. Add the following options in the ``/etc/named.conf`` file: #. Add the following options in the ``/etc/named.conf`` file::
.. code-block:: none
options { options {
... ...
@ -62,9 +60,7 @@ Install and configure components
# rndc-confgen -a -k designate -c /etc/designate/rndc.key -r /dev/urandom # rndc-confgen -a -k designate -c /etc/designate/rndc.key -r /dev/urandom
#. Add the key to ``/etc/named.conf``: #. Add the key to ``/etc/named.conf``::
.. code-block:: none
... ...
include "/etc/designate/rndc.key"; include "/etc/designate/rndc.key";

8
doc/source/install/install-rdo.rst
View File

@ -43,9 +43,7 @@ Install and configure components
# yum install bind bind-utils # yum install bind bind-utils
#. Add the following options in the ``/etc/named.conf`` file: #. Add the following options in the ``/etc/named.conf`` file::
.. code-block:: none
options { options {
... ...
@ -62,9 +60,7 @@ Install and configure components
# rndc-confgen -a -k designate -c /etc/designate/rndc.key -r /dev/urandom # rndc-confgen -a -k designate -c /etc/designate/rndc.key -r /dev/urandom
#. Add the key to ``/etc/named.conf``: #. Add the key to ``/etc/named.conf``::
.. code-block:: none
... ...
include "/etc/designate/rndc.key"; include "/etc/designate/rndc.key";

4
doc/source/install/install-ubuntu.rst
View File

@ -49,9 +49,7 @@ Install and configure components
# rndc-confgen -a -k designate -c /etc/designate/rndc.key # rndc-confgen -a -k designate -c /etc/designate/rndc.key
#. Add the following options in the ``/etc/bind/named.conf.options`` file: #. Add the following options in the ``/etc/bind/named.conf.options`` file::
.. code-block:: none
... ...
include "/etc/designate/rndc.key"; include "/etc/designate/rndc.key";

4
etc/designate/README-designate.conf.txt
View File

@ -1,4 +1,4 @@
To generate the sample designate.conf file, run the following command from the top To generate the sample designate.conf file, run the following command from the
level of the designate directory: top level of the designate directory:
tox -e genconfig tox -e genconfig

1
test-requirements.txt
View File

@ -19,3 +19,4 @@ tempest>=17.1.0 # Apache-2.0
bandit>=1.1.0 # Apache-2.0 bandit>=1.1.0 # Apache-2.0
zake>=0.1.6 # Apache-2.0 zake>=0.1.6 # Apache-2.0
doc8>=0.6.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0
Pygments>=2.2.0 # BSD license

6
tox.ini
View File

@ -70,8 +70,7 @@ deps = -r{toxinidir}/test-requirements.txt
basepython = python3 basepython = python3
commands = sh tools/pretty_flake8.sh commands = sh tools/pretty_flake8.sh
{[testenv:bandit]commands} {[testenv:bandit]commands}
doc8 README.rst releasenotes/source doc/source rally-jobs \ doc8 {posargs}
devstack/README.rst contrib --ignore D000
[testenv:genconfig] [testenv:genconfig]
commands = oslo-config-generator --config-file=etc/designate/designate-config-generator.conf commands = oslo-config-generator --config-file=etc/designate/designate-config-generator.conf
@ -126,6 +125,9 @@ commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenote
[testenv:venv] [testenv:venv]
commands = {posargs} commands = {posargs}
[doc8]
ignore-path = .venv,.git,.tox,*designate/locale*,*lib/python*,*designate.egg*,api-ref/build,doc/build,doc/source/contributor/api
[flake8] [flake8]
# ignored flake8 codes: # ignored flake8 codes:
# H105 don't use author tags. We use version control instead # H105 don't use author tags. We use version control instead