summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2009-06-13 20:55:10 -0400
committerNed Batchelder <ned@nedbatchelder.com>2009-06-13 20:55:10 -0400
commitc00cdf3ed55fb6922476d931362ebca053716a4f (patch)
treeb10982edb0f24b1603fdb2e084ee9af23d429099 /doc
parent02f3bff7f238bb63e2f370db1699275595dbca55 (diff)
downloadpython-coveragepy-git-c00cdf3ed55fb6922476d931362ebca053716a4f.tar.gz
Point to new docs; more doc tweaks.
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile3
-rw-r--r--doc/cmd.rst8
-rw-r--r--doc/faq.rst7
-rw-r--r--doc/index.rst18
-rw-r--r--doc/sample_html/index.html2
5 files changed, 25 insertions, 13 deletions
diff --git a/doc/Makefile b/doc/Makefile
index a820e372..ab00b44c 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -32,11 +32,14 @@ html:
px:
$(SPHINXBUILD) -b px $(ALLSPHINXOPTS) _build/px
+ rm _build/px/search.px
@echo
@echo "Build finished. The HTML pages are in _build/px."
publish:
+ rm c:/ned/web/stellated/pages/code/coverage/*.px
cp _build/px/*.px c:/ned/web/stellated/pages/code/coverage
+ rm c:/ned/web/stellated/pages/code/coverage/sample_html/*.*
cp sample_html/*.* c:/ned/web/stellated/pages/code/coverage/sample_html
text:
diff --git a/doc/cmd.rst b/doc/cmd.rst
index 9f945193..2f8ec170 100644
--- a/doc/cmd.rst
+++ b/doc/cmd.rst
@@ -29,7 +29,7 @@ Some of these can be combined: for example, "-e -x" is the simple way to run a
program without carrying over previous data.
-Data File
+Data file
---------
Coverage collects execution data in a file called ".coverage". If need be, you can
@@ -58,7 +58,7 @@ By default, coverage does not measure code installed with the Python interpreter
If you want to measure that code as well as your own, add the -L flag.
-Combining Data Files
+Combining data files
--------------------
If you need to collect coverage data from different machines, coverage can
@@ -119,7 +119,7 @@ will omit any modules in the django directory::
-HTML Annotation
+HTML annotation
---------------
Coverage can annotate your source code for which lines were executed
@@ -138,7 +138,7 @@ The -d argument to specify an output directory is required::
$ coverage -b -d covhtml
-Text Annotation
+Text annotation
---------------
The -a flag produces a text annotation of your source code. With a -d argument
diff --git a/doc/faq.rst b/doc/faq.rst
index 364ed998..54be5656 100644
--- a/doc/faq.rst
+++ b/doc/faq.rst
@@ -6,7 +6,7 @@ FAQ and Other Help
:history: 20090613T141800, brand new docs.
-Frequently Asked Questions
+Frequently asked questions
--------------------------
**Q: Why do unexecutable lines show up as executed?**
@@ -42,14 +42,15 @@ It's good, but `it isn't perfect
<http://nedbatchelder.com/blog/200710/flaws_in_coverage_measurement.html>`_.
-Getting More Help
+Getting more help
-----------------
You can discuss coverage or get help using it on the `Testing In Python
<http://lists.idyll.org/listinfo/testing-in-python>`_ mailing list.
Bug reports are gladly accepted at the `bitbucket issue tracker
-<http://bitbucket.org/ned/coveragepy/issues/>`_.
+<http://bitbucket.org/ned/coveragepy/issues/>`_. Bitbucket also hosts the
+`code repository <http://bitbucket.org/ned/coveragepy>`_.
Lastly, `I can be reached <http://nedbatchelder.com/site/aboutned.html>`_ in a
number of ways.
diff --git a/doc/index.rst b/doc/index.rst
index f7eed9d8..4d889e2d 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -9,11 +9,15 @@ Coverage.py is a tool for measuring code coverage of Python programs. It
monitors your program, noting which parts of the code have been executed, then
analyzes the source to identify code that could have been executed but was not.
+Coverage measurement is typically used to gauge the effectiveness of tests. It
+can show which parts of your product code are being exercised by tests, and
+which are not.
-Quick Start
+
+Quick start
-----------
-Getting started with coverage.py is easy:
+Coverage.py works on Python 2.3 through 2.6. Getting started is easy:
#. Install coverage.py from the
`coverage page on the cheeseshop <http://pypi.python.org/pypi/coverage>`_,
@@ -50,10 +54,10 @@ Getting started with coverage.py is easy:
`report like this </code/coverage/sample_html/index.html>`_.
-Using coverage
---------------
+Using coverage.py
+-----------------
-There are a few different ways to use coverage. The simplest is the
+There are a few different ways to use coverage.py. 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>`.
@@ -74,6 +78,10 @@ Coverage.py was originally written by `Gareth Rees <http://garethrees.org/>`_.
Ned Batchelder has maintained and extended it since 2004.
+Resources
+---------
+
+
More information
----------------
diff --git a/doc/sample_html/index.html b/doc/sample_html/index.html
index f49a9c7c..41097e9d 100644
--- a/doc/sample_html/index.html
+++ b/doc/sample_html/index.html
@@ -69,7 +69,7 @@
<div id='footer'>
<div class='content'>
<p>
- <a class='nav' href='http://bitbucket.org/ned/coveragepy/'>coverage v3.0c1</a>
+ <a class='nav' href='http://nedbatchelder.com/code/coverage'>coverage v3.0</a>
</p>
</div>
</div>