Merge pull request #10225 from nicoddemus/sort-fixtures-docs

Author: nicoddemus

doc/en/reference/reference.rst

@@ -333,50 +333,6 @@ For more details, consult the full :ref:`fixtures docs <fixture>`.
     :decorator:
 
 
-.. fixture:: cache
-
-config.cache
-~~~~~~~~~~~~
-
-**Tutorial**: :ref:`cache`
-
-The ``config.cache`` object allows other plugins and fixtures
-to store and retrieve values across test runs. To access it from fixtures
-request ``pytestconfig`` into your fixture and get it with ``pytestconfig.cache``.
-
-Under the hood, the cache plugin uses the simple
-``dumps``/``loads`` API of the :py:mod:`json` stdlib module.
-
-``config.cache`` is an instance of :class:`pytest.Cache`:
-
-.. autoclass:: pytest.Cache()
-   :members:
-
-
-.. fixture:: capsys
-
-capsys
-~~~~~~
-
-**Tutorial**: :ref:`captures`
-
-.. autofunction:: _pytest.capture.capsys()
-    :no-auto-options:
-
-.. autoclass:: pytest.CaptureFixture()
-    :members:
-
-
-.. fixture:: capsysbinary
-
-capsysbinary
-~~~~~~~~~~~~
-
-**Tutorial**: :ref:`captures`
-
-.. autofunction:: _pytest.capture.capsysbinary()
-    :no-auto-options:
-
 .. fixture:: capfd
 
 capfd
@@ -387,6 +343,7 @@ capfd
 .. autofunction:: _pytest.capture.capfd()
     :no-auto-options:
 
+
 .. fixture:: capfdbinary
 
 capfdbinary
@@ -398,71 +355,74 @@ capfdbinary
     :no-auto-options:
 
 
-.. fixture:: doctest_namespace
-
-doctest_namespace
-~~~~~~~~~~~~~~~~~
-
-**Tutorial**: :ref:`doctest`
+.. fixture:: caplog
 
-.. autofunction:: _pytest.doctest.doctest_namespace()
+caplog
+~~~~~~
 
+**Tutorial**: :ref:`logging`
 
-.. fixture:: request
+.. autofunction:: _pytest.logging.caplog()
+    :no-auto-options:
 
-request
-~~~~~~~
+    Returns a :class:`pytest.LogCaptureFixture` instance.
 
-**Example**: :ref:`request example`
+.. autoclass:: pytest.LogCaptureFixture()
+    :members:
 
-The ``request`` fixture is a special fixture providing information of the requesting test function.
 
-.. autoclass:: pytest.FixtureRequest()
-    :members:
+.. fixture:: capsys
 
+capsys
+~~~~~~
 
-.. fixture:: pytestconfig
+**Tutorial**: :ref:`captures`
 
-pytestconfig
-~~~~~~~~~~~~
+.. autofunction:: _pytest.capture.capsys()
+    :no-auto-options:
 
-.. autofunction:: _pytest.fixtures.pytestconfig()
+.. autoclass:: pytest.CaptureFixture()
+    :members:
 
+.. fixture:: capsysbinary
 
-.. fixture:: record_property
+capsysbinary
+~~~~~~~~~~~~
 
-record_property
-~~~~~~~~~~~~~~~~~~~
+**Tutorial**: :ref:`captures`
 
-**Tutorial**: :ref:`record_property example`
+.. autofunction:: _pytest.capture.capsysbinary()
+    :no-auto-options:
 
-.. autofunction:: _pytest.junitxml.record_property()
 
+.. fixture:: cache
 
-.. fixture:: record_testsuite_property
+config.cache
+~~~~~~~~~~~~
 
-record_testsuite_property
-~~~~~~~~~~~~~~~~~~~~~~~~~
+**Tutorial**: :ref:`cache`
 
-**Tutorial**: :ref:`record_testsuite_property example`
+The ``config.cache`` object allows other plugins and fixtures
+to store and retrieve values across test runs. To access it from fixtures
+request ``pytestconfig`` into your fixture and get it with ``pytestconfig.cache``.
 
-.. autofunction:: _pytest.junitxml.record_testsuite_property()
+Under the hood, the cache plugin uses the simple
+``dumps``/``loads`` API of the :py:mod:`json` stdlib module.
 
+``config.cache`` is an instance of :class:`pytest.Cache`:
 
-.. fixture:: caplog
+.. autoclass:: pytest.Cache()
+   :members:
 
-caplog
-~~~~~~
 
-**Tutorial**: :ref:`logging`
+.. fixture:: doctest_namespace
 
-.. autofunction:: _pytest.logging.caplog()
-    :no-auto-options:
+doctest_namespace
+~~~~~~~~~~~~~~~~~
 
-    Returns a :class:`pytest.LogCaptureFixture` instance.
+**Tutorial**: :ref:`doctest`
 
-.. autoclass:: pytest.LogCaptureFixture()
-    :members:
+.. autofunction:: _pytest.doctest.doctest_namespace()
 
 
 .. fixture:: monkeypatch
@@ -481,6 +441,14 @@ monkeypatch
     :members:
 
 
+.. fixture:: pytestconfig
+
+pytestconfig
+~~~~~~~~~~~~
+
+.. autofunction:: _pytest.fixtures.pytestconfig()
+
+
 .. fixture:: pytester
 
 pytester
@@ -517,19 +485,25 @@ To use it, include in your topmost ``conftest.py`` file:
 .. autoclass:: pytest.RecordedHookCall()
     :members:
 
-.. fixture:: testdir
 
-testdir
-~~~~~~~
+.. fixture:: record_property
 
-Identical to :fixture:`pytester`, but provides an instance whose methods return
-legacy ``py.path.local`` objects instead when applicable.
+record_property
+~~~~~~~~~~~~~~~~~~~
 
-New code should avoid using :fixture:`testdir` in favor of :fixture:`pytester`.
+**Tutorial**: :ref:`record_property example`
 
-.. autoclass:: pytest.Testdir()
-    :members:
-    :noindex: TimeoutExpired
+.. autofunction:: _pytest.junitxml.record_property()
+
+
+.. fixture:: record_testsuite_property
+
+record_testsuite_property
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Tutorial**: :ref:`record_testsuite_property example`
+
+.. autofunction:: _pytest.junitxml.record_testsuite_property()
 
 
 .. fixture:: recwarn
@@ -546,6 +520,34 @@ recwarn
     :members:
 
 
+.. fixture:: request
+
+request
+~~~~~~~
+
+**Example**: :ref:`request example`
+
+The ``request`` fixture is a special fixture providing information of the requesting test function.
+
+.. autoclass:: pytest.FixtureRequest()
+    :members:
+
+
+.. fixture:: testdir
+
+testdir
+~~~~~~~
+
+Identical to :fixture:`pytester`, but provides an instance whose methods return
+legacy ``py.path.local`` objects instead when applicable.
+
+New code should avoid using :fixture:`testdir` in favor of :fixture:`pytester`.
+
+.. autoclass:: pytest.Testdir()
+    :members:
+    :noindex: TimeoutExpired
+
+
 .. fixture:: tmp_path
 
 tmp_path