holger krekel committed 3f52ff3

update docs and rework them to better fit readthedocs

  • Participants
  • Parent commits d0b88e0
  • Tags 1.1

Comments (0)

Files changed (10)


 - fix issue5 - don't require argparse for python versions that have it
 - inline (1.6.1) script to avoid a number of issues, 
   particularly failing to install python3 environents from a python2 
   virtualenv installation.
+- rework and enhance docs for display on

File doc/_static/sphinxdoc.css

 div.related {
-    font-size: 1em;
+    font-size: 0.8em;
 div.related ul {

File doc/_templates/layout.html

 {% 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>
-{% endblock %}
 {% block footer %}
 {{ super() }}

File doc/announce/release-1.1.txt

+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:
+    pip install -U tox
+Note that code hosting and issue tracking has moved from Google to Bitbucket:
+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!
+Holger Krekel
+- 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 (1.6.1) script to avoid a number of issues, 
+  particularly failing to install python3 environents from a python2 
+  virtualenv installation.
 #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.

File doc/index.txt

 Welcome to the tox automation project
-.. note::
-    Bug reports, feedback, contributions welcome: see :ref:`support`.
 vision: merge testing and deployment
 .. _pypy:
-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 `` 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::
+   announce/release-1.1
 .. include:: links.txt

File doc/install.txt

 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
         description='virtualenv-based automation of test activities',
-        version='1.1.dev5',
+        version='1.1',
         license='GPLv2 or later',
         platforms=['unix', 'linux', 'osx', 'cygwin', 'win32'],
         author='holger krekel',

File tox/

-__version__ = '1.1.dev5'
+__version__ = '1.1'
 class exception:
     class Error(Exception):


-__version__ = '1.1.dev5'
+__version__ = '1.1'
 import sys
 import os