Add caplog to reference

pytest-dev · Mar 6, 2018 · adcb28f · adcb28f
1 parent 111c6d6
commit adcb28f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/doc/en/logging.rst b/doc/en/logging.rst
@@ -160,11 +160,9 @@ the records for the ``setup`` and ``call`` stages during teardown like so:
                 pytest.fail('warning messages encountered during testing: {}'.format(messages))
 
 
-caplog fixture API
-~~~~~~~~~~~~~~~~~~
 
-.. autoclass:: _pytest.logging.LogCaptureFixture
-    :members:
+The full API is available at :class:`_pytest.logging.LogCaptureFixture`.
+
 
 .. _live_logs:
 

diff --git a/doc/en/reference.rst b/doc/en/reference.rst
@@ -5,7 +5,7 @@ Reference
 This page contains the full reference to pytest's API.
 
 .. contents::
-    :depth: 2
+    :depth: 3
     :local:
 
 
@@ -423,3 +423,14 @@ record_xml_property
 ~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: _pytest.junitxml.record_xml_property()
+
+caplog
+~~~~~~
+
+.. autofunction:: _pytest.logging.caplog()
+    :no-auto-options:
+
+    This returns a :class:`_pytest.logging.LogCaptureFixture`.
+
+.. autoclass:: _pytest.logging.LogCaptureFixture
+    :members: