diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2022-10-24 06:03:47 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2023-05-13 06:29:44 -0400 |
| commit | 5f46920e363fe4d5459ee9e15ec25b09038ca880 (patch) | |
| tree | aa50fad298b25fdb217981ce6f0a1c8cd42adacd | |
| parent | 41c122b15c210552e9363835316885a520bf567f (diff) | |
| download | python-coveragepy-git-nedbat/make-upgrade-docs-tools.tar.gz | |
Revert "docs: don't use tabs while we work out the docutil version pinning"nedbat/make-upgrade-docs-tools
This reverts commit 87de75db8c2590b54816daf5848d478100b29b00.
| -rw-r--r-- | doc/conf.py | 2 | ||||
| -rw-r--r-- | doc/index.rst | 30 |
2 files changed, 17 insertions, 15 deletions
diff --git a/doc/conf.py b/doc/conf.py index fbd7e3f3..9b9a3f1e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -39,7 +39,7 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinxcontrib.restbuilder', 'sphinx.ext.napoleon', - #'sphinx_tabs.tabs', + 'sphinx_tabs.tabs', ] autodoc_typehints = "description" diff --git a/doc/index.rst b/doc/index.rst index 2420aa6f..59dfdb51 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -73,7 +73,9 @@ Getting started is easy: Other instructions for specific test runners: - - **pytest** + .. tabs:: + + .. tab:: pytest If you usually use:: @@ -86,7 +88,7 @@ Getting started is easy: Many people choose to use the `pytest-cov`_ plugin, but for most purposes, it is unnecessary. - - **unittest** + .. tab:: unittest Change "python" to "coverage run", so this:: @@ -96,18 +98,18 @@ Getting started is easy: $ coverage run -m unittest discover - .. - **nosetest** - .. - .. *Nose has been unmaintained for a long time. You should seriously - .. consider adopting a different test runner.* - .. - .. Change this:: - .. - .. $ nosetests arg1 arg2 - .. - .. to this:: - .. - .. $ coverage run -m nose arg1 arg2 + .. tab:: nosetest + + *Nose has been unmaintained for a long time. You should seriously + consider adopting a different test runner.* + + Change this:: + + $ nosetests arg1 arg2 + + to:: + + $ coverage run -m nose arg1 arg2 To limit coverage measurement to code in the current directory, and also find files that weren't executed at all, add the ``--source=.`` argument to |