diff --git a/.gitignore b/.gitignore index 0eda1d05..5912f289 100644 --- a/.gitignore +++ b/.gitignore @@ -44,7 +44,8 @@ vagrant-settings.yaml .cache .tox - +ChangeLog +AUTHORS .coverage diff --git a/doc-test.conf b/doc-test.conf new file mode 100644 index 00000000..f86cc542 --- /dev/null +++ b/doc-test.conf @@ -0,0 +1,2 @@ +[DEFAULT] +repo_name = solar diff --git a/tox.ini b/tox.ini index cca52db8..4bc92ce6 100644 --- a/tox.ini +++ b/tox.ini @@ -8,6 +8,8 @@ usedevelop = True install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} passenv = SOLAR_DB + +[testenv:py27] deps = -r{toxinidir}/test-requirements.txt commands = ostestr @@ -17,12 +19,40 @@ usedevelop = False commands = flake8 {posargs:solar} -[testenv:docs] -deps = -r{toxinidir}/requirements.txt - sphinx +[testenv:checkniceness] +deps = openstack-doc-tools>=0.30 + doc8 commands = - rm -rf doc/build + openstack-doc-test --check-niceness + doc8 doc + +[testenv:checksyntax] +deps = openstack-doc-tools>=0.30 +commands = + openstack-doc-test --check-syntax + +[testenv:docs] +deps = sphinx + {[testenv:checkniceness]deps} +whitelist_externals = /bin/rm +commands = + /bin/rm -rf doc/build python setup.py build_sphinx + {[testenv:checkniceness]commands} + {[testenv:checksyntax]commands} + +[doc8] +# Settings for doc8: +# Ignore target directories +ignore-path = doc/build* +# File extensions to use +extensions = .rst,.txt +# Maximal line length should be 79 but we have some overlong lines. +# Let's not get far more in. +max-line-length = 80 +# Disable some doc8 checks: +# D000: Check RST validity (cannot handle lineos directive) +ignore = D000 [testenv:venv] deps = -r{toxinidir}/requirements.txt