diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2009-06-08 09:05:15 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-06-08 09:05:15 -0400 |
| commit | fedbbd4169378f6b807c13806b4415878a788bca (patch) | |
| tree | 35be4887811ad65ad5dbd5c1004316ca71519200 | |
| parent | 392bf6cab5c0e72b5811f57b8e157424149ce81d (diff) | |
| download | python-coveragepy-git-fedbbd4169378f6b807c13806b4415878a788bca.tar.gz | |
Progress on docs
| -rw-r--r-- | doc/_templates/px/layout.html | 8 | ||||
| -rw-r--r-- | doc/index.rst | 17 |
2 files changed, 19 insertions, 6 deletions
diff --git a/doc/_templates/px/layout.html b/doc/_templates/px/layout.html index 4bcebd25..19056897 100644 --- a/doc/_templates/px/layout.html +++ b/doc/_templates/px/layout.html @@ -6,4 +6,12 @@ {% block document -%} {%- block body %} {% endblock -%} {%- endblock %} + +{%- if prev or next %} +<p class='pmn pmnbot'> + {% if prev %}<span class='p'>« <i>Previous:</i> <a href="{{ prev.link|e }}" title="previous topic">{{ prev.title }}</a></span>{% endif %} + {% if next %}<span class='n'><i>Next:</i> <a href="{{ next.link|e }}" title="next topic">{{ next.title }}</a> »</span>{% endif %} +</p> +{%- endif %} + </page> diff --git a/doc/index.rst b/doc/index.rst index 2305eeca..a4cd1f17 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,9 +15,9 @@ Quick Start Getting started with coverage.py is easy:
#. Install coverage.py from the
- `coverage page on the cheeseshop <http://pypi.python.org/pypi/coverage>`_.
- TODO: easy_install coverage?
- TODO: need python-dev
+ `coverage page on the cheeseshop <http://pypi.python.org/pypi/coverage>`_,
+ or by using "easy_install coverage". You may need to install the python-dev
+ support files, for example with "apt-get install python-dev".
#. Run coverage to execute your program and gather data:
@@ -52,8 +52,14 @@ Getting started with coverage.py is easy: Using coverage
--------------
-There are two supported interfaces to coverage: a :ref:`command line <cmd>` and
-an :ref:`API <api>`.
+There are a few different ways to use coverage. The simplest is the
+:ref:`command line <cmd>`, which lets you run your program and see the results.
+If you need more control over how your project is measured, you can use the
+:ref:`API <api>`.
+
+Some test runners provide coverage integration to make it easy to use coverage
+while running tests. For example, `nose <http://somethingaboutorange.com/mrl/projects/nose>`
+has a `cover plug-in <http://somethingaboutorange.com/mrl/projects/nose/0.11.1/plugins/cover.html>`_.
More information
@@ -67,7 +73,6 @@ More information changes
-.. ez_install installation instructions.
.. FAQ
.. Why do unexecutable lines show up as executed?
.. Why do the bodies of fns show as executed, but the def lines do not?
|