6c906c06d1
- First patch only modifies tox.ini to add an html-only build option to iterate quickly. - Modify .gitignore for working on Mac OSX locally. Next patches in series will take care of: - Adds a Project-only search form in bottom of left-hand navigation bar Trying to differentiate between project-scoped search and broad site search. - The "Project Home page" link renamed from "Contents" in nav. - Build number now available in lines "Updated" also is displayed. Shows a bulleted list with "Current" if that is the only available version. Seems to have a lot of space, okay? - Add a link to project source in sidebar. Change-Id: Ic71c1f7c17048c521fce4b08989b0c57c175e043
73 lines
2.0 KiB
INI
73 lines
2.0 KiB
INI
[tox]
|
|
minversion = 2.0
|
|
envlist = pep8
|
|
|
|
[testenv]
|
|
usedevelop = False
|
|
install_command = {toxinidir}/tools/tox_install.sh {env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
|
|
deps = -r{toxinidir}/test-requirements.txt
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
BRANCH_NAME=master
|
|
CLIENT_NAME=openstackdocstheme
|
|
sitepackages = False
|
|
whitelist_externals =
|
|
rm
|
|
make
|
|
|
|
[testenv:pep8]
|
|
commands =
|
|
flake8 openstackdocstheme
|
|
|
|
[testenv:venv]
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
commands =
|
|
rm -rf doc/build api-ref/build
|
|
python setup.py build_sphinx
|
|
sphinx-build -a -E -W -d doc/build/doctrees -b latex doc/source doc/build/pdf
|
|
make -C doc/build/pdf
|
|
sphinx-build -a -E -W -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html
|
|
|
|
[testenv:html]
|
|
commands =
|
|
rm -rf doc/build api-ref/build
|
|
python setup.py build_sphinx
|
|
sphinx-build -a -E -W -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html
|
|
|
|
[testenv:releasenotes]
|
|
commands =
|
|
rm -rf releasenotes/build
|
|
sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
|
|
|
[testenv:api-ref]
|
|
commands =
|
|
rm -rf api-ref/build
|
|
sphinx-build -a -E -W -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html
|
|
|
|
|
|
[testenv:checkbuild]
|
|
# Only build PDF and push it to publish-docs folder so that OpenStack
|
|
# CI jobs will publish it.
|
|
whitelist_externals =
|
|
make
|
|
cp
|
|
mkdir
|
|
commands =
|
|
sphinx-build -a -E -W -d doc/build/doctrees -b latex doc/source doc/build/pdf
|
|
make -C doc/build/pdf
|
|
mkdir publish-docs
|
|
cp doc/build/pdf/os-doc-demo.pdf publish-docs
|
|
|
|
[testenv:bindep]
|
|
# Do not install any requirements. We want this to be fast and work even if
|
|
# system dependencies are missing, since it's used to tell you what system
|
|
# dependencies are missing! This also means that bindep must be installed
|
|
# separately, outside of the requirements files.
|
|
deps = bindep
|
|
commands = bindep test
|
|
|
|
[flake8]
|
|
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
|
|
show-source = True
|