From 063fb8661b59ec78c60c8c2c97e8356c897eab73 Mon Sep 17 00:00:00 2001 From: Nguyen Van Trung Date: Thu, 10 May 2018 10:08:06 +0700 Subject: [PATCH] Allow to check pep8 along with D000 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 --- README.rst | 6 +++--- doc/source/install/install-obs.rst | 8 ++------ doc/source/install/install-rdo.rst | 8 ++------ doc/source/install/install-ubuntu.rst | 4 +--- etc/designate/README-designate.conf.txt | 6 +++--- test-requirements.txt | 1 + tox.ini | 6 ++++-- 7 files changed, 16 insertions(+), 23 deletions(-) diff --git a/README.rst b/README.rst index c5b99ba98..e7c859c42 100644 --- a/README.rst +++ b/README.rst @@ -28,9 +28,9 @@ Setup 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 virtualenv .venv . .venv/bin/activate @@ -42,7 +42,7 @@ Building Docs To build the documentation from the restructured text source, do the following: -.. code-block:: shell +.. code-block:: bash cd doc pip install -r requirements.txt diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst index 341c91ead..f45947c69 100644 --- a/doc/source/install/install-obs.rst +++ b/doc/source/install/install-obs.rst @@ -43,9 +43,7 @@ Install and configure components # zypper install bind bind-utils -#. Add the following options in the ``/etc/named.conf`` file: - - .. code-block:: none +#. Add the following options in the ``/etc/named.conf`` file:: options { ... @@ -62,9 +60,7 @@ Install and configure components # rndc-confgen -a -k designate -c /etc/designate/rndc.key -r /dev/urandom -#. Add the key to ``/etc/named.conf``: - - .. code-block:: none +#. Add the key to ``/etc/named.conf``:: ... include "/etc/designate/rndc.key"; diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst index 4c62f0804..1a60c4405 100644 --- a/doc/source/install/install-rdo.rst +++ b/doc/source/install/install-rdo.rst @@ -43,9 +43,7 @@ Install and configure components # yum install bind bind-utils -#. Add the following options in the ``/etc/named.conf`` file: - - .. code-block:: none +#. Add the following options in the ``/etc/named.conf`` file:: options { ... @@ -62,9 +60,7 @@ Install and configure components # rndc-confgen -a -k designate -c /etc/designate/rndc.key -r /dev/urandom -#. Add the key to ``/etc/named.conf``: - - .. code-block:: none +#. Add the key to ``/etc/named.conf``:: ... include "/etc/designate/rndc.key"; diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst index a6f2c1ba3..1fed8b905 100644 --- a/doc/source/install/install-ubuntu.rst +++ b/doc/source/install/install-ubuntu.rst @@ -49,9 +49,7 @@ Install and configure components # rndc-confgen -a -k designate -c /etc/designate/rndc.key -#. Add the following options in the ``/etc/bind/named.conf.options`` file: - - .. code-block:: none +#. Add the following options in the ``/etc/bind/named.conf.options`` file:: ... include "/etc/designate/rndc.key"; diff --git a/etc/designate/README-designate.conf.txt b/etc/designate/README-designate.conf.txt index 5ce3ae5ab..d5da93598 100644 --- a/etc/designate/README-designate.conf.txt +++ b/etc/designate/README-designate.conf.txt @@ -1,4 +1,4 @@ -To generate the sample designate.conf file, run the following command from the top -level of the designate directory: +To generate the sample designate.conf file, run the following command from the +top level of the designate directory: - tox -e genconfig \ No newline at end of file + tox -e genconfig diff --git a/test-requirements.txt b/test-requirements.txt index 851ff4a42..bcad4f1e9 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -19,3 +19,4 @@ tempest>=17.1.0 # Apache-2.0 bandit>=1.1.0 # Apache-2.0 zake>=0.1.6 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 +Pygments>=2.2.0 # BSD license diff --git a/tox.ini b/tox.ini index 40e231e4c..50b96b970 100644 --- a/tox.ini +++ b/tox.ini @@ -70,8 +70,7 @@ deps = -r{toxinidir}/test-requirements.txt basepython = python3 commands = sh tools/pretty_flake8.sh {[testenv:bandit]commands} - doc8 README.rst releasenotes/source doc/source rally-jobs \ - devstack/README.rst contrib --ignore D000 + doc8 {posargs} [testenv:genconfig] 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] commands = {posargs} +[doc8] +ignore-path = .venv,.git,.tox,*designate/locale*,*lib/python*,*designate.egg*,api-ref/build,doc/build,doc/source/contributor/api + [flake8] # ignored flake8 codes: # H105 don't use author tags. We use version control instead