Add pep8 environment to the tox.ini file

Because we have several Python files inside this repository we should
be able to check them.

Change-Id: Iaf4a013cf0c109d60b5421c5077505fdcbb4a30c
This commit is contained in:
Christian Berendt 2015-02-06 10:57:34 +01:00
parent 398ef9fa12
commit 7524c8b34f
5 changed files with 149 additions and 115 deletions

View File

@ -1,3 +1,16 @@
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# HOT Templates Guide documentation build configuration file, created by # HOT Templates Guide documentation build configuration file, created by
# sphinx-quickstart on Fri Jul 18 15:27:11 2014. # sphinx-quickstart on Fri Jul 18 15:27:11 2014.
# #
@ -10,8 +23,8 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys # import os
import os # import sys
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the

View File

@ -1,5 +1,16 @@
# -*- coding: utf-8 -*- # Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# #
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
# containing dir. # containing dir.
# #
@ -9,8 +20,8 @@
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import sys # import os
import os # import sys
import openstackdocstheme import openstackdocstheme
@ -241,8 +252,9 @@ man_pages = [
texinfo_documents = [ texinfo_documents = [
('index', 'UserGuide', u'User Guide', ('index', 'UserGuide', u'User Guide',
u'OpenStack contributors', 'UserGuide', u'OpenStack contributors', 'UserGuide',
'This guide shows OpenStack end users how to create and manage resources in an OpenStack cloud with the OpenStack dashboard and OpenStack client commands.', 'This guide shows OpenStack end users how to create and manage resources '
'Miscellaneous'), 'in an OpenStack cloud with the OpenStack dashboard and OpenStack client '
'commands.', 'Miscellaneous'),
] ]
# Documents to append as an appendix to all manuals. # Documents to append as an appendix to all manuals.

View File

@ -2,6 +2,8 @@
# of appearance. Changing the order has an impact on the overall integration # of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
beautifulsoup4 beautifulsoup4
# Hacking already pins down pep8, pyflakes and flake8
hacking>=0.10.0,<0.11
Jinja2>=2.6 # BSD License (3 clause) Jinja2>=2.6 # BSD License (3 clause)
doc8 # Apache-2.0 doc8 # Apache-2.0
openstack-doc-tools>=0.21.1 openstack-doc-tools>=0.21.1

View File

@ -12,8 +12,6 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
# author: Christian Berendt <berendt@b1-systems.de>
import argparse import argparse
import logging import logging
import os import os

View File

@ -26,6 +26,7 @@ commands = openstack-doc-test --check-links {posargs}
commands = commands =
openstack-doc-test --check-niceness {posargs} openstack-doc-test --check-niceness {posargs}
doc8 doc doc8 doc
flake8
[testenv:checksyntax] [testenv:checksyntax]
commands = commands =
@ -99,3 +100,11 @@ commands = doc-tools-check-languages doc-tools-check-languages.conf publish all
ignore-path = doc/*/target ignore-path = doc/*/target
# File extensions to use # File extensions to use
extensions = .rst,.txt extensions = .rst,.txt
[flake8]
show-source = True
# H803 skipped on purpose per list discussion.
# E123, E125 skipped as they are invalid PEP-8.
ignore = E123,E125,H803
builtins = _
exclude=.venv,.git,.tox,dist,*openstack/common*,*lib/python*,*egg,build,doc/common/samples