Skip to content

Commit

Permalink
docs: don't use tabs while we work out the docutil version pinning
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Aug 15, 2022
1 parent 4eee7dc commit 87de75d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Expand Up @@ -40,7 +40,7 @@
'sphinx.ext.intersphinx',
'sphinxcontrib.restbuilder',
'sphinx.ext.napoleon',
'sphinx_tabs.tabs',
#'sphinx_tabs.tabs',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
30 changes: 14 additions & 16 deletions doc/index.rst
Expand Up @@ -68,9 +68,7 @@ Getting started is easy:

Instructions for specific test runners:

.. tabs::

.. tab:: pytest
- **pytest**

If you usually use::

Expand All @@ -83,7 +81,7 @@ Getting started is easy:
Many people choose to use the `pytest-cov`_ plugin, but for most
purposes, it is unnecessary.

.. tab:: unittest
- **unittest**

Change "python" to "coverage run", so this::

Expand All @@ -93,18 +91,18 @@ Getting started is easy:

$ coverage run -m unittest discover

.. 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
.. - **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
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
Expand Down

0 comments on commit 87de75d

Please sign in to comment.