diff options
| -rw-r--r-- | doc/_templates/indexsidebar.html | 2 | ||||
| -rw-r--r-- | doc/_templates/layout.html | 16 | ||||
| -rw-r--r-- | doc/check_sphinx.py | 2 | ||||
| -rw-r--r-- | doc/example/general.txt | 6 | ||||
| -rw-r--r-- | doc/example/hudson.txt | 33 |
5 files changed, 30 insertions, 29 deletions
diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html index 9d11b39..12bf335 100644 --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -17,5 +17,5 @@ <h3>Questions? Suggestions?</h3> -<p><Checkout <a href="{{ pathto('support') }}">support channels</a> +<p>Checkout <a href="{{ pathto('support') }}">support channels</a> </p> diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html index 2cd15d0..4f54bcf 100644 --- a/doc/_templates/layout.html +++ b/doc/_templates/layout.html @@ -12,14 +12,14 @@ {% block header %} <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px"> -<h1>tox: virtualenv-based automation of test activities</h1> -<div style="text-align: left; font-size: 130%; vertical-align: middle;"> - <a href="{{ pathto('index') }}">home</a> | - <a href="{{ pathto('install') }}">install</a> | - <a href="{{ pathto('examples') }}">examples</a> | - <a href="{{ pathto('config') }}">config</a> | - <a href="{{ pathto('support') }}">support</a> -</div> + <h1>tox: virtualenv-based automation of test activities</h1> + <div style="text-align: left; font-size: 130%; vertical-align: middle;"> + <a href="{{ pathto('index') }}">home</a> | + <a href="{{ pathto('install') }}">install</a> | + <a href="{{ pathto('examples') }}">examples</a> | + <a href="{{ pathto('config') }}">config</a> | + <a href="{{ pathto('support') }}">support</a> + </div> </div> {% endblock %} diff --git a/doc/check_sphinx.py b/doc/check_sphinx.py index 1d87ee8..cf284ec 100644 --- a/doc/check_sphinx.py +++ b/doc/check_sphinx.py @@ -4,7 +4,7 @@ def test_linkcheck(tmpdir): doctrees = tmpdir.join("doctrees") htmldir = tmpdir.join("html") subprocess.check_call( - ["sphinx-build", "-W", "-blinkcheck", + ["sphinx-build", "-blinkcheck", "-d", str(doctrees), ".", str(htmldir)]) def test_build_docs(tmpdir): diff --git a/doc/example/general.txt b/doc/example/general.txt index 1649602..ebdd443 100644 --- a/doc/example/general.txt +++ b/doc/example/general.txt @@ -105,11 +105,11 @@ Example ``tox.ini`` for project ``two``:: {distshare}/two-*.zip # install latest package from "two" project Tox running on project ``one`` will copy the sdist-package into the -``distshare`` directory after a ``tox` run on project ``two`` will -grab it because the ``deps`` contain an entry with the +``distshare`` directory after which a ``tox`` run on project ``two`` will +grab it because ``deps`` contain an entry with the ``two-*.zip`` pattern. If there is more than one matching package the highest version will be taken. ``tox`` uses verlib_ to -compare version strings which must be compliant with :pep:`385`. +compare version strings which must be compliant with :pep:`386`. .. _verlib: http://bitbucket.org/tarek/distutilsversion/ .. include:: ../links.txt diff --git a/doc/example/hudson.txt b/doc/example/hudson.txt index 65dafab..4a28d52 100644 --- a/doc/example/hudson.txt +++ b/doc/example/hudson.txt @@ -50,13 +50,11 @@ and does not need to be in use or installed with any other environment. Access package artifacts between Hudson jobs -------------------------------------------------------- -.. _`general artifact exchange mechanism`: general.html#artifacts .. _`Hudson Copy Artifact plugin`: http://wiki.hudson-ci.org/display/HUDSON/Copy+Artifact+Plugin -In an extension to the `general artifact exchange mechanism`_ -you can configure Hudson jobs to access each other artifacts. -As far as ``tox`` is concerned you should configure a special -directory for the hudson context like this:: +In an extension to :ref:`artifacts` you can configure Hudson jobs to +access each others artifacts. ``tox`` allows to define +global variables in a per-hudson context like this:: [tox:hudson] distshare=.tox/distshare @@ -65,17 +63,20 @@ This means that each workspace will have its own ``distshare`` directory and we need to configure some artifact copying. The recommend way to do this is to install the `Hudson Copy Artifact plugin`_ and for each job which "receives" artifacts you add a **Copy artifacts from another project** -build step using roughly this configuration: - - ``Project-name``: the name of the other (tox-managed) job you want the artifact from - ``Artifacts to copy``: ``.tox/dist/*.zip - ``Target directory``: .tox/distshare - Flatten Directories: CHECK - -If you add such a build step at the beginning then Hudson will -copy the other artifact into our ``distshare`` directory -and thus ``tox`` will be able to find it like -in the non-Hudson case. +build step using roughly this configuration:: + + Project-name: the name of the other (tox-managed) job you want the artifact from + Artifacts to copy: .tox/dist/*.zip # where the other jobs creates its artifacts + Target directory: .tox/distshare # where we want it to appear for us + Flatten Directories: CHECK # copy files flatly, create no subdir-structure + +If you add such a build step before your ``tox`` run the latter +can install the dependency just like :ref:`artifacts` shows it. +In other words, the only difference in ``tox.ini`` between Hudson +and non-Hudson artifact sharing is the value for the ``distshare`` +directory which can be set separately so that the rest of your +``tox.ini`` is fully re-useable and can be debugged on a +developer console. .. include:: ../links.txt |