Skip to content

Commit 8410d9a

Browse files
committed
Created a new Explanation section and new landing pages for main sections.
Added landing pages for: How-to guides Reference guides Explanation Added links to the main landing pages to the sidebar.
1 parent ff2ee96 commit 8410d9a

File tree

10 files changed

+78
-9
lines changed

10 files changed

+78
-9
lines changed

doc/en/_templates/globaltoc.html

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,20 @@ <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
22

33
<ul>
44
<li><a href="{{ pathto('index') }}">Home</a></li>
5+
56
<li><a href="{{ pathto('getting-started') }}">Get started</a></li>
7+
<li><a href="{{ pathto('how-to/index') }}">How-to guides</a></li>
8+
<li><a href="{{ pathto('reference/index') }}">Reference guides</a></li>
9+
<li><a href="{{ pathto('explanation/index') }}">Explanation</a></li>
10+
611
<li><a href="{{ pathto('example/index') }}">Examples</a></li>
7-
<li><a href="{{ pathto('customize') }}">Customize</a></li>
8-
<li><a href="{{ pathto('reference') }}">API Reference</a></li>
9-
<li><a href="{{ pathto('plugin_list') }}">3rd party plugins</a></li>
12+
13+
<li><a href="{{ pathto('reference/customize') }}">Customize</a></li>
14+
<li><a href="{{ pathto('reference/reference') }}">API Reference</a></li>
15+
<li><a href="{{ pathto('reference/plugin_list') }}">3rd party plugins</a></li>
16+
1017
<li><a href="{{ pathto('contents') }}">Complete table of contents</a></li>
18+
1119
<li><a href="{{ pathto('changelog') }}">Changelog</a></li>
1220
<li><a href="{{ pathto('contributing') }}">Contributing</a></li>
1321
<li><a href="{{ pathto('backwards-compatibility') }}">Backwards Compatibility</a></li>

doc/en/contents.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,25 @@ Reference guides
5757
reference/reference
5858

5959

60+
Explanation
61+
-----------------
62+
63+
.. toctree::
64+
:maxdepth: 2
65+
66+
explanation/anatomy
67+
explanation/fixtures
68+
explanation/goodpractices
69+
explanation/flaky
70+
explanation/pythonpath
71+
72+
6073
Further topics
6174
-----------------
6275

6376
.. toctree::
6477
:maxdepth: 2
6578

66-
anatomy
67-
fixtures
68-
goodpractices
69-
flaky
70-
pythonpath
7179
example/index
7280

7381
backwards-compatibility
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/en/goodpractices.rst renamed to doc/en/explanation/goodpractices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Conventions for Python test discovery
4848
* ``test`` prefixed test functions or methods outside of class
4949
* ``test`` prefixed test functions or methods inside ``Test`` prefixed test classes (without an ``__init__`` method)
5050

51-
For examples of how to customize your test discovery :doc:`example/pythoncollection`.
51+
For examples of how to customize your test discovery :doc:`/example/pythoncollection`.
5252

5353
Within Python modules, ``pytest`` also discovers tests using the standard
5454
:ref:`unittest.TestCase <unittest.TestCase>` subclassing technique.

doc/en/explanation/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:orphan:
2+
3+
Explanation
4+
================
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
anatomy
10+
fixtures
11+
goodpractices
12+
flaky
13+
pythonpath
File renamed without changes.

doc/en/how-to/index.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:orphan:
2+
3+
How-to guides
4+
================
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
usage
10+
existingtestsuite
11+
assert
12+
mark
13+
monkeypatch
14+
tmpdir
15+
capture
16+
skipping
17+
parametrize
18+
plugins
19+
nose
20+
bash-completion
21+
fixtures

doc/en/reference/index.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:orphan:
2+
3+
Reference guides
4+
================
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
fixtures
10+
warnings
11+
doctest
12+
cache
13+
unittest
14+
xunit_setup
15+
plugin_list
16+
writing_plugins
17+
logging
18+
customize
19+
reference

0 commit comments

Comments
 (0)