[py-svn] commit/pytest: hpk42: rearrange and streamline documentation navigation to better work
Bitbucket
commits-noreply at bitbucket.org
Wed Jul 6 20:22:56 CEST 2011
1 new changeset in pytest:
http://bitbucket.org/hpk42/pytest/changeset/5f32895f8c3c/
changeset: 5f32895f8c3c
user: hpk42
date: 2011-07-06 20:21:59
summary: rearrange and streamline documentation navigation to better work
with readthedocs and also with PDF generation.
affected #: 12 files (3.3 KB)
--- a/CHANGELOG Wed Jul 06 10:18:11 2011 +0200
+++ b/CHANGELOG Wed Jul 06 20:21:59 2011 +0200
@@ -13,7 +13,8 @@
- fix issue48: typo in MarkInfo repr leading to exception
- fix issue49: avoid confusing error when initizaliation partially fails
- fix issue44: env/username expansion for junitxml file path
-- show releaselevel information for pypy
+- show releaselevel information in test runs for pypy
+- reworked doc pages for better navigation and PDF generation
Changes between 2.0.2 and 2.0.3
----------------------------------------------
--- a/doc/_static/sphinxdoc.css Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/_static/sphinxdoc.css Wed Jul 06 20:21:59 2011 +0200
@@ -48,7 +48,7 @@
}
div.related {
- font-size: 1em;
+ font-size: 0.8em;
}
div.related ul {
--- a/doc/_templates/indexsidebar.html Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/_templates/indexsidebar.html Wed Jul 06 20:21:59 2011 +0200
@@ -10,7 +10,7 @@
<p><b><a href="{{ pathto('announce/index')}}">{{ release }} release</a></b>
[<a href="{{ pathto('changelog') }}">Changelog</a>]</p><p>
-<a href="http://pypi.python.org/pypi/pytest">pytest on PyPI</a>
+<a href="http://pypi.python.org/pypi/pytest">pytest/PyPI</a></p><pre>easy_install pytest</pre><pre>pip install pytest</pre>
--- a/doc/_templates/layout.html Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/_templates/layout.html Wed Jul 06 20:21:59 2011 +0200
@@ -1,29 +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>pytest: rapid no-boilerplate testing with Python</h1>
- <div style="text-align: left; font-size: 130%; vertical-align: middle;">
- <a href="{{ pathto('index') }}">home</a> |
- <a href="{{ pathto('contents') }}">all docs</a> |
- <a href="{{ pathto('getting-started') }}">install</a> |
- <a href="{{ pathto('example/index') }}">examples</a> |
- <a href="{{ pathto('customize') }}">customize</a> |
- <a href="https://bitbucket.org/hpk42/pytest/issues?status=new&status=open">issues</a>|
- <a href="{{ pathto('contact') }}">contact</a>
- </div>
-</div>
-{% endblock %}
{% block footer %}
{{ super() }}
--- a/doc/conf.py Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/conf.py Wed Jul 06 20:21:59 2011 +0200
@@ -107,10 +107,10 @@
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-#html_title = None
+html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+html_short_title = "pytest-%s" % release
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@ -136,7 +136,7 @@
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
-html_sidebars = {'index': 'indexsidebar.html'}
+#html_sidebars = {'*': 'sidebar.html'}
# Additional templates that should be rendered to pages, maps page names to
# template names.
@@ -145,16 +145,16 @@
# If false, no module index is generated.
-#html_domain_indices = True
+html_domain_indices = True
# If false, no index is generated.
-#html_use_index = True
+html_use_index = False
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
--- a/doc/contents.txt Wed Jul 06 10:18:11 2011 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,33 +0,0 @@
-
-.. _toc:
-
-Table of Contents
-========================
-
-.. note::
- version 2.0 introduces :ref:`pytest as the main Python import name <naming20>`
-
-.. toctree::
- :maxdepth: 2
-
- overview
- apiref
- plugins
- example/index
- talks
- develop
- announce/index
-
-.. toctree::
- :hidden:
-
- changelog.txt
- naming20.txt
- example/attic
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
--- a/doc/example/index.txt Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/example/index.txt Wed Jul 06 20:21:59 2011 +0200
@@ -7,6 +7,10 @@
Here is a (growing) list of examples. :ref:`Contact <contact>` us if you
need more examples or have questions. Also take a look at the :ref:`comprehensive documentation <toc>` which contains many example snippets as well.
+.. note::
+
+ see :doc:`../getting-started` for basic introductionary examples
+
.. toctree::
:maxdepth: 2
--- a/doc/index.txt Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/index.txt Wed Jul 06 20:21:59 2011 +0200
@@ -1,62 +1,24 @@
+.. _toc:
-Welcome to ``py.test``!
-=============================================
+Table of Contents
+========================
+.. toctree::
+ :maxdepth: 2
-- **a mature full-featured testing tool**
-
- - runs on Posix/Windows, Python 2.4-3.2, PyPy and Jython
- - continuously `tested on many Python interpreters <http://hudson.testrun.org/view/pytest/job/pytest/>`_
- - used in :ref:`many projects and organisations <projects>`, in test
- suites ranging from 10 to 10s of thousands of tests
- - has :ref:`comprehensive documentation <toc>`
- - comes with :ref:`tested examples <examples>`
- - supports :ref:`good integration practises <goodpractises>`
-
-- **provides no-boilerplate testing**
-
- - makes it :ref:`easy to get started <getstarted>`,
- - refined :ref:`usage options <usage>`
- - :ref:`assert with the assert statement`
- - helpful :ref:`traceback and failing assertion reporting <tbreportdemo>`
- - allows :ref:`print debugging <printdebugging>` and :ref:`the
- capturing of standard output during test execution <captures>`
- - supports :pep:`8` compliant coding styles in tests
-
-- **supports functional testing and complex test setups**
-
- - advanced :ref:`skip and xfail`
- - generic :ref:`marking and test selection <mark>`
- - can :ref:`distribute tests to multiple CPUs <xdistcpu>` through :ref:`xdist plugin <xdist>`
- - can :ref:`continuously re-run failing tests <looponfailing>`
- - many :ref:`builtin helpers <pytest helpers>`
- - flexible :ref:`Python test discovery`
- - unique :ref:`dependency injection through funcargs <funcargs>`
- - :ref:`parametrized test functions <parametrized test functions>`
-
-- **integrates many common testing methods**
-
- - can integrate ``nose``, ``unittest.py`` and ``doctest.py`` style
- tests, including running testcases made for Django and trial
- - supports extended :ref:`xUnit style setup <xunitsetup>`
- - supports domain-specific :ref:`non-python tests`
- - supports the generation of testing coverage reports
- - `Javascript unit- and functional testing`_
-
-- **extensive plugin and customization system**
-
- - all collection, reporting, running aspects are delegated to hook functions
- - customizations can be per-directory, per-project or per PyPI released plugins
- - it is easy to add command line options or do other kind of add-ons and customizations.
-
-.. _`Javascript unit- and functional testing`: http://pypi.python.org/pypi/oejskit
-
-.. _`easy`: http://bruynooghe.blogspot.com/2009/12/skipping-slow-test-by-default-in-pytest.html
+ overview
+ example/index
+ apiref
+ plugins
+ talks
+ develop
+ announce/index
.. toctree::
:hidden:
- contact.txt
- contents.txt
+ changelog.txt
+ naming20.txt
+ example/attic
--- a/doc/overview.txt Wed Jul 06 10:18:11 2011 +0200
+++ b/doc/overview.txt Wed Jul 06 20:21:59 2011 +0200
@@ -5,6 +5,7 @@
.. toctree::
:maxdepth: 2
+ features.txt
getting-started.txt
usage.txt
goodpractises.txt
Repository URL: https://bitbucket.org/hpk42/pytest/
--
This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
More information about the pytest-commit
mailing list