diff --git a/README.rst b/README.rst index 33f3d6c..395b921 100644 --- a/README.rst +++ b/README.rst @@ -6,10 +6,10 @@ Watcher Specifications ====================== -This git repository is used to hold approved design specifications for additions -to the Watcher project. Reviews of the specs are done in gerrit, using a -similar workflow to how we review and merge changes to the code itself. For -specific policies around specification review, refer to the end of this +This git repository is used to hold approved design specifications for +additions to the Watcher project. Reviews of the specs are done in gerrit, +using a similar workflow to how we review and merge changes to the code itself. +For specific policies around specification review, refer to the end of this document. The layout of this repository is:: @@ -112,11 +112,15 @@ was previously approved but not implemented (or not completely implemented), then you must seek re-approval for the specification. You can re-propose your specification by doing the following: -* Copy (not move) your specification to the right directory for the current release. +* Copy (not move) your specification to the right directory for the current + release. * Update the document to comply with the new template. -* If there are no functional changes to the specification (only template changes) then add the `Previously-approved: ` tag to your commit message. +* If there are no functional changes to the specification (only template + changes) then add the `Previously-approved: ` tag to your commit + message. * Send for review. -* watcher-specs-core will merge specifications which meet these requirements with a single +2. +* watcher-specs-core will merge specifications which meet these requirements + with a single +2. Specifications which depend on merging code in other OpenStack projects ----------------------------------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 38d1071..af00a52 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -27,7 +27,8 @@ Here you can find the specs, and spec template, for each release: specs/mitaka/index -There are also some approved backlog specifications that are looking for owners: +There are also some approved backlog specifications that are looking for +owners: .. toctree:: :glob: diff --git a/requirements.txt b/requirements.txt index 7df18d2..ea04bc1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,4 @@ sphinx>=1.1.2,<1.2 testrepository>=0.0.18 testtools>=0.9.34 yasfb>=0.5.1 +doc8 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index 8e4be6b..d781067 100644 --- a/setup.cfg +++ b/setup.cfg @@ -12,6 +12,7 @@ classifier = Operating System :: POSIX :: Linux [build_sphinx] +fresh_env = 1 all_files = 1 build-dir = doc/build source-dir = doc/source diff --git a/tox.ini b/tox.ini index 37c697f..fb126a5 100644 --- a/tox.ini +++ b/tox.ini @@ -12,21 +12,24 @@ install_command = pip install -U {opts} {packages} deps = -r{toxinidir}/requirements.txt whitelist_externals = find commands = - find . -type f -name "*.pyc" -delete - python setup.py testr --slowest --testr-args='{posargs}' + find . -type f -name "*.pyc" -delete + python setup.py testr --slowest --testr-args='{posargs}' [testenv:venv] commands = {posargs} [testenv:docs] +setenv = PYTHONHASHSEED=0 commands = - find . -type f -name "*.pyc" -delete - python setup.py build_sphinx + find . -type f -name "*.pyc" -delete + doc8 doc/source/ README.rst + python setup.py build_sphinx [testenv:pep8] deps = -r{toxinidir}/test-requirements.txt commands = - flake8 {posargs} + doc8 doc/source/ README.rst + flake8 {posargs} [flake8] ignore = E128