diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 12 | ||||
| -rw-r--r-- | doc/index.rst | 33 |
2 files changed, 37 insertions, 8 deletions
diff --git a/doc/conf.py b/doc/conf.py index b8636818..e4dd824d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -24,7 +24,7 @@ sys.path.append(os.path.join(os.path.dirname(__file__), "_ext")) # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'px_xlator']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'px_xlator']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -204,3 +204,13 @@ latex_documents = [ # When auto-doc'ing a class, write the class' docstring and the __init__ docstring
# into the class docs.
autoclass_content = "both"
+
+
+
+
+
+prerelease = bool(max(release).isalpha())
+
+def setup(app):
+ app.add_config_value('prerelease', False, 'env')
+ print "** Prerelease = %r" % prerelease
diff --git a/doc/index.rst b/doc/index.rst index cf595de2..8c9709d8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -27,8 +27,19 @@ Coverage measurement is typically used to gauge the effectiveness of tests. It can show which parts of your code are being exercised by tests, and which are not. -The latest version is 3.5b1, released 5 June 2011. -It is supported on Python versions 2.3 through 3.2. +.. ifconfig:: not prerelease + + The latest version is coverage.py 3.4, released 10 September 2010. + It is supported on Python versions 2.3 through 3.2. + +.. ifconfig:: prerelease + + The latest version is coverage.py 3.5b1, released 5 June 2011. + This is a pre-release build. The usual warnings about possible bugs apply. + It is supported on Python versions 2.3 through 3.2. + The latest stable version is coverage.py 3.4, `described here`_. + +.. _described here: http://nedbatchelder.com/code.coverage Quick start @@ -66,11 +77,19 @@ Getting started is easy: $ coverage html - Then visit htmlcov/index.html in your browser, to see a - `report like this`_. + .. ifconfig:: not prerelease + + Then visit htmlcov/index.html in your browser, to see a + `report like this`_. + + .. ifconfig:: prerelease + + Then visit htmlcov/index.html in your browser, to see a + `report like this one`_. .. _coverage page on the Python Package Index: http://pypi.python.org/pypi/coverage .. _report like this: /code/coverage/sample_html/index.html +.. _report like this one: /code/coverage/sample_html_beta/index.html Using coverage.py @@ -106,11 +125,11 @@ Bitbucket also hosts the `code repository`_. .. _Bitbucket issue tracker: http://bitbucket.org/ned/coveragepy/issues .. _code repository: http://bitbucket.org/ned/coveragepy -`I can be reached`__ in a number of ways, I'm happy to answer questions about +`I can be reached`_ in a number of ways. I'm happy to answer questions about using coverage.py. I'm also available hourly for consultation or custom development. -__ http://nedbatchelder.com/site/aboutned.html +.. _I can be reached: http://nedbatchelder.com/site/aboutned.html @@ -123,11 +142,11 @@ More information install cmd config - api source excluding branch subprocess + api faq changes |