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.
This commit is contained in:
Daniele Procida 2021-03-12 22:57:53 +00:00
parent ff2ee96b8c
commit 8410d9ac54
10 changed files with 78 additions and 9 deletions

View File

@ -2,12 +2,20 @@
<ul>
<li><a href="{{ pathto('index') }}">Home</a></li>
<li><a href="{{ pathto('getting-started') }}">Get started</a></li>
<li><a href="{{ pathto('how-to/index') }}">How-to guides</a></li>
<li><a href="{{ pathto('reference/index') }}">Reference guides</a></li>
<li><a href="{{ pathto('explanation/index') }}">Explanation</a></li>
<li><a href="{{ pathto('example/index') }}">Examples</a></li>
<li><a href="{{ pathto('customize') }}">Customize</a></li>
<li><a href="{{ pathto('reference') }}">API Reference</a></li>
<li><a href="{{ pathto('plugin_list') }}">3rd party plugins</a></li>
<li><a href="{{ pathto('reference/customize') }}">Customize</a></li>
<li><a href="{{ pathto('reference/reference') }}">API Reference</a></li>
<li><a href="{{ pathto('reference/plugin_list') }}">3rd party plugins</a></li>
<li><a href="{{ pathto('contents') }}">Complete table of contents</a></li>
<li><a href="{{ pathto('changelog') }}">Changelog</a></li>
<li><a href="{{ pathto('contributing') }}">Contributing</a></li>
<li><a href="{{ pathto('backwards-compatibility') }}">Backwards Compatibility</a></li>

View File

@ -57,17 +57,25 @@ Reference guides
reference/reference
Explanation
-----------------
.. toctree::
:maxdepth: 2
explanation/anatomy
explanation/fixtures
explanation/goodpractices
explanation/flaky
explanation/pythonpath
Further topics
-----------------
.. toctree::
:maxdepth: 2
anatomy
fixtures
goodpractices
flaky
pythonpath
example/index
backwards-compatibility

View File

@ -48,7 +48,7 @@ Conventions for Python test discovery
* ``test`` prefixed test functions or methods outside of class
* ``test`` prefixed test functions or methods inside ``Test`` prefixed test classes (without an ``__init__`` method)
For examples of how to customize your test discovery :doc:`example/pythoncollection`.
For examples of how to customize your test discovery :doc:`/example/pythoncollection`.
Within Python modules, ``pytest`` also discovers tests using the standard
:ref:`unittest.TestCase <unittest.TestCase>` subclassing technique.

View File

@ -0,0 +1,13 @@
:orphan:
Explanation
================
.. toctree::
:maxdepth: 1
anatomy
fixtures
goodpractices
flaky
pythonpath

21
doc/en/how-to/index.rst Normal file
View File

@ -0,0 +1,21 @@
:orphan:
How-to guides
================
.. toctree::
:maxdepth: 1
usage
existingtestsuite
assert
mark
monkeypatch
tmpdir
capture
skipping
parametrize
plugins
nose
bash-completion
fixtures

View File

@ -0,0 +1,19 @@
:orphan:
Reference guides
================
.. toctree::
:maxdepth: 1
fixtures
warnings
doctest
cache
unittest
xunit_setup
plugin_list
writing_plugins
logging
customize
reference