summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorholger krekel <holger@merlinux.eu>2011-07-08 17:15:39 +0200
committerholger krekel <holger@merlinux.eu>2011-07-08 17:15:39 +0200
commita7f7b5666c94f5f9a663a80cb7c6c126d8ec455a (patch)
treef69166e7885f4d99ac864211efc63645c8bfeea7 /doc
parente085fd6a204a6dac4aa039097d0ccb5f253599d7 (diff)
downloadtox-1.1.tar.gz
update docs and rework them to better fit readthedocs1.1
Diffstat (limited to 'doc')
-rw-r--r--doc/_static/sphinxdoc.css2
-rw-r--r--doc/_templates/layout.html22
-rw-r--r--doc/announce/release-1.1.txt50
-rw-r--r--doc/conf.py2
-rw-r--r--doc/index.txt30
-rw-r--r--doc/install.txt7
6 files changed, 54 insertions, 59 deletions
diff --git a/doc/_static/sphinxdoc.css b/doc/_static/sphinxdoc.css
index 02b940b..ab8ab5d 100644
--- a/doc/_static/sphinxdoc.css
+++ b/doc/_static/sphinxdoc.css
@@ -48,7 +48,7 @@ div.body {
}
div.related {
- font-size: 1em;
+ font-size: 0.8em;
}
div.related ul {
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
index 4f54bcf..1892483 100644
--- a/doc/_templates/layout.html
+++ b/doc/_templates/layout.html
@@ -1,27 +1,5 @@
{% extends "!layout.html" %}
-{% block relbar1 %}
-{% endblock %}
-{% block relbar2 %}
-{% endblock %}
-
-{% block rootrellink %}
-{% endblock %}
-{% block sidebarrel %}
-{% endblock %}
-
-{% 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>&nbsp;|&nbsp;
- <a href="{{ pathto('install') }}">install</a>&nbsp;|&nbsp;
- <a href="{{ pathto('examples') }}">examples</a>&nbsp;|&nbsp;
- <a href="{{ pathto('config') }}">config</a>&nbsp;|&nbsp;
- <a href="{{ pathto('support') }}">support</a>&nbsp;
- </div>
-</div>
-{% endblock %}
{% block footer %}
{{ super() }}
diff --git a/doc/announce/release-1.1.txt b/doc/announce/release-1.1.txt
new file mode 100644
index 0000000..a41c72f
--- /dev/null
+++ b/doc/announce/release-1.1.txt
@@ -0,0 +1,50 @@
+tox 1.1: the rapid multi-python test automatizer
+===========================================================================
+
+I am happy to announce tox 1.1, a bug fix release easing some commong
+workflows. TOX automates tedious test activities driven from a simple
+``tox.ini`` file, including:
+
+* creation and management of different virtualenv environments with
+ different Python interpreters
+* packaging and installing your package into each of them
+* running your test tool of choice, be it nose, py.test or unittest2 or
+ other tools such as "sphinx" doc checks
+* testing dev packages against each other without needing to upload to PyPI
+
+It works well on virtually all Python interpreters that support virtualenv.
+
+Docs and examples are at:
+
+ http://tox.readthedocs.org
+
+Installation:
+
+ pip install -U tox
+
+Note that code hosting and issue tracking has moved from Google to Bitbucket:
+
+ http://bitbucket.org/hpk42/tox
+
+The 1.0 release includes contributions and is based on feedback and
+work from Chris Rose, Ronny Pfannschmidt, Jannis Leidel, Jakob Kaplan-Moss,
+Sridhar Ratnakumar, Carl Meyer and others. Many thanks!
+
+best,
+Holger Krekel
+
+CHANGES
+---------------------
+
+- fix issue5 - don't require argparse for python versions that have it
+- fix issue6 - recreate virtualenv if installing dependencies failed
+- fix issue3 - fix example on frontpage
+- fix issue2 - warn if a test command does not come from the test
+ environment
+- fixed/enhanced: except for initial install always call "-U
+ --no-deps" for installing the sdist package to ensure that a package
+ gets upgraded even if its version number did not change. (reported on
+ TIP mailing list and IRC)
+- inline virtualenv.py (1.6.1) script to avoid a number of issues,
+ particularly failing to install python3 environents from a python2
+ virtualenv installation.
diff --git a/doc/conf.py b/doc/conf.py
index bc4b67b..960b50e 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -132,7 +132,7 @@ html_static_path = ['_static']
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
-html_sidebars = {'index': 'indexsidebar.html'}
+#html_sidebars = {'index': 'indexsidebar.html'}
# Additional templates that should be rendered to pages, maps page names to
# template names.
diff --git a/doc/index.txt b/doc/index.txt
index 30c52b0..6cf4b06 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,10 +1,6 @@
Welcome to the tox automation project
===============================================
-.. note::
-
- Bug reports, feedback, contributions welcome: see :ref:`support`.
-
vision: merge testing and deployment
----------------------------------------
@@ -89,31 +85,6 @@ Current features
.. _pypy: http://pypy.org
-Notes and known limitations
-----------------------------------
-
-* ``tox`` always operates in virtualenv_ environments, it cannot work with
- globally installed Python interpreters because there are no reliable means
- to install and recreate dependencies. Or does it still makes sense to
- allow using global Python installations?
-
-* ``tox`` is fresh on the Python testing scene (first release July 2010) and
- needs some battle testing and feedback. It is is likely to evolve in
- (possibly incompatible) increments as it provides more power to configure
- and customize the test process.
-
-* ``tox`` uses virtualenv_ and virtualenv5_, the latter being a fork
- of virtualenv3_ which roughly works with Python3 but has less features
- (no "pip" and other problems). This comes with limitations and you
- may run into them when trying to create python3 based virtual environments.
- IMO the proper solution is: virtualenv_ needs to merge
- and grow proper native Python3 support, preferably in a "single-source" way.
-
-* ``tox`` currently uses a ``setup.py sdist`` invocation to create
- an installable package and then invokes ``pip`` or ``easy_install`` to
- install into each test environment. There is no support for other
- installation methods.
-
.. _`tox.ini`: :doc:configfile
.. toctree::
@@ -127,6 +98,7 @@ Notes and known limitations
links
announce/release-0.5
announce/release-1.0
+ announce/release-1.1
.. include:: links.txt
diff --git a/doc/install.txt b/doc/install.txt
index 8f67efe..6394920 100644
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -1,15 +1,10 @@
tox installation
==================================
-.. note::
-
- tox is alpha software and may have crucial platform-specific
- or environment specific bugs. Use with care.
-
Install info in a nutshell
----------------------------------
-**Pythons**: 2.4, 2.5, 2.6, 2.7, 3.0, 3.1.x, Jython-2.5.1, PyPy-trunk
+**Pythons**: CPython 2.4-3.2, Jython-2.5.1, pypy-1.5
**Operating systems**: Linux, Windows, OSX, Unix