Tools used by OpenStack Documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

65 lines
2.2 KiB

  1. [tox]
  2. minversion = 2.0
  3. envlist = py3,py27,pep8
  4. skipsdist = True
  5. [testenv]
  6. usedevelop = True
  7. install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
  8. setenv =
  9. VIRTUAL_ENV={envdir}
  10. CLIENT_NAME=openstack-doc-tools
  11. # Install also sitemap scraping tool, not installed by default
  12. # therefore not in requirements file
  13. deps = scrapy>=1.0.0
  14. -r{toxinidir}/test-requirements.txt
  15. -r{toxinidir}/requirements.txt
  16. commands = python setup.py testr --slowest --testr-args='{posargs}'
  17. [testenv:pep8]
  18. commands =
  19. flake8
  20. # Run doc8 to check .rst and .txt files.
  21. # HACKING.rst is the only file that is not referenced from
  22. # doc/source, so add it explicitly.
  23. doc8 -e txt -e rst doc/source/ HACKING.rst
  24. # Run bashate during pep8 runs to ensure violations are caught by
  25. # the check and gate queues.
  26. bashate autogenerate_config_docs/autohelp-wrapper \
  27. bin/doc-tools-check-languages \
  28. cleanup/remove_trailing_whitespaces.sh
  29. [testenv:pylint]
  30. commands = pylint os_doc_tools cleanup sitemap
  31. [testenv:releasenotes]
  32. commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
  33. [testenv:sitemap]
  34. # commands = functional test command goes here
  35. [testenv:venv]
  36. commands = {posargs}
  37. [testenv:docs]
  38. commands = python setup.py build_sphinx
  39. [testenv:bindep]
  40. # Do not install any requirements. We want this to be fast and work even if
  41. # system dependencies are missing, since it's used to tell you what system
  42. # dependencies are missing! This also means that bindep must be installed
  43. # separately, outside of the requirements files, and develop mode disabled
  44. # explicitly to avoid unnecessarily installing the checked-out repo too (this
  45. # further relies on "tox.skipsdist = True" above).
  46. deps = bindep
  47. commands = bindep test
  48. usedevelop = False
  49. [flake8]
  50. show-source = True
  51. builtins = _
  52. exclude=.venv,.git,.tox,dist,*lib/python*,*egg,build,*autogenerate_config_docs/venv,*autogenerate_config_docs/sources,doc/source/conf.py
  53. # 28 is currently the most complex thing we have
  54. max-complexity=29
  55. ignore = H101