Skip to content

Commit 85de883

Browse files
committed
Add menus of items for different audiences
1 parent 4c7b4ca commit 85de883

File tree

5 files changed

+122
-0
lines changed

5 files changed

+122
-0
lines changed

doc/en/new-docs/advanceduser.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
.. _`advanceduser`:
2+
3+
Advanced User
4+
=============
5+
6+
* Plugin recommendations
7+
* conftest.py
8+
* .ini config
9+
* Adding extra functionality to marks
10+
* Advanced parametrize
11+
12+
13+
More on fixtures:
14+
15+
* Defining fixture scope
16+
* Parametrized fixtures
17+
18+
19+
Test suite speed:
20+
21+
* Running tests in parallel
22+
* Profiling slow tests
23+
24+
25+
Integrating testing into development:
26+
27+
* Testing against multiple Python interpreters with Tox
28+
* Continuous integration (CI) systems
29+
* Test coverage
30+
* Debugging
31+
* Python warnings
32+
* Logging
33+
* Flaky tests
34+
35+
36+
Different styles of testing:
37+
38+
* Mock
39+
* GUI testing
40+
* Web browser testing
41+
* Running unittest/nose tests
42+
* Migrating from unittest to pytest
43+
* Migrating from nose to pytest
44+
* Running non-Python tests
45+
* Running doctests
46+
* Behaviour-driven development (BDD) style tests
47+
* Property-based testing (such as Hypothesis)

doc/en/new-docs/contributor.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _`contributor`:
2+
3+
Contributor
4+
===========
5+
6+
* Setting up a development environment
7+
* Contribution suggestions
8+
* Git branch guide
9+
* Preparing a pull request
10+
* Project organisation
11+
* Pytest history
12+
* Projects that use pytest

doc/en/new-docs/index.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,48 @@ If you get an error checkout :ref:`installation issues`.
3636
Audiences
3737
---------
3838

39+
3940
User
4041
~~~~
4142

4243
This section covers the basics to get you running and writing automated tests
4344
in pytest.
4445

46+
:ref:`user`
47+
48+
4549
Advanced User
4650
~~~~~~~~~~~~~
4751

4852
This section dives deeper into pytest features such as fixtures and
4953
parametrization, how to extend pytest through hooks and gives advice on
5054
different styles of testing.
5155

56+
:ref:`advanceduser`
57+
58+
5259
Plugin Author
5360
~~~~~~~~~~~~~
5461

5562
This section guides you in creating plugins to customize and extend pytest.
5663

64+
:ref:`pluginauthor`
65+
66+
5767
Contributor
5868
~~~~~~~~~~~
5969

6070
If you are interested in contributing to pytest, this section will point you in
6171
the right direction.
72+
73+
:ref:`contributor`
74+
75+
76+
77+
References
78+
----------
79+
80+
* Command-line options
81+
* Pytest namespace
82+
* Hooks
83+
* Built-in fixtures

doc/en/new-docs/pluginauthor.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _`pluginauthor`:
2+
3+
Plugin Author
4+
=============
5+
6+
* Get started with the Cookiecutter template
7+
* Introduction to hooks
8+
* Registering a plugin with pytest (setup.py)
9+
* Recommended practice for publishing (moving to pytest-dev)
10+
* Adding a command-line option
11+
* Testing plugins
12+
* Using the pytest cache

doc/en/new-docs/user.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _`user`:
2+
3+
User
4+
====
5+
6+
Writing tests
7+
-------------
8+
9+
* Assert statements
10+
* Test naming conventions and discovery
11+
* Test directory structure
12+
* Asserting about exceptions with pytest.raises
13+
* Using pytest.mark to group tests
14+
* Skip and skipif marks
15+
* xfail mark
16+
* parametrize basics
17+
* Fixture basics
18+
* Fixture finalizers
19+
* Monkeypatch fixture
20+
21+
22+
Running tests
23+
-------------
24+
25+
* Most useful command-line options
26+
* IDE integration
27+
* Types of test results
28+
* Stdout capturing
29+
* What happens when you press Ctrl-C?

0 commit comments

Comments
 (0)