Skip to content

Commit d869541

Browse files
committed
Added how-to and reference directories.
Moved various documents into subdirectories, how-to and reference. Updated multiple links to use `:ref:` instead of `:doc:`, meaning that files can henceforth be moved around without breaking references.
1 parent 4b7edef commit d869541

28 files changed

+71
-65
lines changed

changelog/5105.doc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Add automatically generated :doc:`plugin_list`. The list is updated on a periodic schedule.
1+
Add automatically generated :ref:`plugin-list`. The list is updated on a periodic schedule.

doc/en/contents.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,18 @@ How-to guides
2323
.. toctree::
2424
:maxdepth: 2
2525

26-
usage
27-
existingtestsuite
28-
assert
29-
mark
30-
monkeypatch
31-
tmpdir
32-
capture
33-
skipping
34-
parametrize
35-
plugins
36-
nose
37-
bash-completion
26+
how-to/usage
27+
how-to/existingtestsuite
28+
how-to/assert
29+
how-to/mark
30+
how-to/monkeypatch
31+
how-to/tmpdir
32+
how-to/capture
33+
how-to/skipping
34+
how-to/parametrize
35+
how-to/plugins
36+
how-to/nose
37+
how-to/bash-completion
3838

3939

4040
Reference guides
@@ -43,17 +43,17 @@ Reference guides
4343
.. toctree::
4444
:maxdepth: 2
4545

46-
fixture
47-
warnings
48-
doctest
49-
cache
50-
unittest
51-
xunit_setup
52-
plugin_list
53-
writing_plugins
54-
logging
55-
customize
56-
reference
46+
reference/fixture
47+
reference/warnings
48+
reference/doctest
49+
reference/cache
50+
reference/unittest
51+
reference/xunit_setup
52+
reference/plugin_list
53+
reference/writing_plugins
54+
reference/logging
55+
reference/customize
56+
reference/reference
5757

5858

5959
Further topics

doc/en/example/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ answers.
1313

1414
For basic examples, see
1515

16-
- :doc:`../getting-started` for basic introductory examples
16+
- :ref:`get-started` for basic introductory examples
1717
- :ref:`assert` for basic assertion examples
1818
- :ref:`Fixtures <fixtures>` for basic fixture/setup examples
1919
- :ref:`parametrize` for basic test function parametrization
20-
- :doc:`../unittest` for basic unittest integration
21-
- :doc:`../nose` for basic nosetests integration
20+
- :ref:`unittest` for basic unittest integration
21+
- :ref:`noseintegration` for basic nosetests integration
2222

2323
The following examples aim at various use cases you might encounter.
2424

doc/en/getting-started.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _get-started:
2+
13
Get Started
24
===================================
35

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/en/monkeypatch.rst renamed to doc/en/how-to/monkeypatch.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. _monkeypatching:
12

23
How to monkeypatch/mock modules and environments
34
================================================================

0 commit comments

Comments
 (0)