Partially suppress warnings in tests.

macfreek · macfreek · commit bf680c6240bf · 2021-02-28T10:12:29.000+01:00
* Use :orphan: to supress "document isn't included in any toctree"
* Add line break between consecutive lists
* Move non-existing target test to separate file (still gives expected warning)
diff --git a/tests/datasets/common/bold.rst b/tests/datasets/common/bold.rst
@@ -1 +1,3 @@
+:orphan:
+
 This is **bold**.
diff --git a/tests/datasets/common/bullet-list-consecutive.rst b/tests/datasets/common/bullet-list-consecutive.rst
@@ -1,4 +1,7 @@
+:orphan:
+
 - one
 - two
+
 * three
 * four
diff --git a/tests/datasets/common/bullet-list.rst b/tests/datasets/common/bullet-list.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 First list:
 
 - one
diff --git a/tests/datasets/common/definition-list.rst b/tests/datasets/common/definition-list.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Definition lists:
 
 what
diff --git a/tests/datasets/common/external-hyperlinks.rst b/tests/datasets/common/external-hyperlinks.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Embedded external hyperlinks, like `Python
 <https://www.python.org/>`_.
 
diff --git a/tests/datasets/common/grid-table.rst b/tests/datasets/common/grid-table.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 +---+---+
 | a | b |
 +===+===+
diff --git a/tests/datasets/common/headings.rst b/tests/datasets/common/headings.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Headline
 ========
 Text immediately following.
diff --git a/tests/datasets/common/hyperlink-targets.rst b/tests/datasets/common/hyperlink-targets.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _target:
 
 The hyperlink target above points to this paragraph.
diff --git a/tests/datasets/common/indentation.rst b/tests/datasets/common/indentation.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Not indented
 
     Four spaces
diff --git a/tests/datasets/common/index.rst b/tests/datasets/common/index.rst
@@ -1,2 +1,4 @@
+:orphan:
+
 This directory contains test of common reStructuredText markup.
 See https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
diff --git a/tests/datasets/common/internal-hyperlinks.rst b/tests/datasets/common/internal-hyperlinks.rst
@@ -1,12 +1,12 @@
+:orphan:
+
 Clicking on this internal hyperlink will take us to the target_
 below.
 
 .. _target:
 
 The hyperlink target above points to this paragraph.
 
-Pointer to a nonexisting_ target.
-
 Titles are targets, too
 =======================
 Implict references, even with spaces, like `Titles are
diff --git a/tests/datasets/common/italic.rst b/tests/datasets/common/italic.rst
@@ -1 +1,3 @@
+:orphan:
+
 This is *italic*.
diff --git a/tests/datasets/common/list-table.rst b/tests/datasets/common/list-table.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. list-table::
     :header-rows: 1
 
diff --git a/tests/datasets/common/literal-block.rst b/tests/datasets/common/literal-block.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Basic literal block:
 
 ::
diff --git a/tests/datasets/common/literal.rst b/tests/datasets/common/literal.rst
@@ -1 +1,3 @@
+:orphan:
+
 This is ``literal``.
diff --git a/tests/datasets/common/multiline-list.rst b/tests/datasets/common/multiline-list.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 * List with long lines.
 * Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent at ante id
   ante interdum porttitor. Cras mollis urna scelerisque, tincidunt diam sit
diff --git a/tests/datasets/common/nested-list.rst b/tests/datasets/common/nested-list.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 * first item
 * second item
     * first sub item
diff --git a/tests/datasets/common/nonexistent-target.rst b/tests/datasets/common/nonexistent-target.rst
@@ -0,0 +1,3 @@
+:orphan:
+
+Pointer to a nonexisting_ target.
diff --git a/tests/datasets/common/ordered-list-properties.rst b/tests/datasets/common/ordered-list-properties.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 3.  This is a numbered list.
 4.  It started with item 3.
 5.  Five
diff --git a/tests/datasets/common/ordered-list.rst b/tests/datasets/common/ordered-list.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 1. This is a numbered list.
 2. It has two items too.
 
diff --git a/tests/datasets/common/paragraph.rst b/tests/datasets/common/paragraph.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 Single line
 
 Two short
diff --git a/tests/datasets/common/simple-table.rst b/tests/datasets/common/simple-table.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 == == ==
 a1 a2 a3
 == == ==
diff --git a/tests/datasets/common/smart-quotes.rst b/tests/datasets/common/smart-quotes.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 This is a line with a quote, isn't it?
 
 This is a line with a smart quote, isn’t it?
diff --git a/tests/datasets/common/subscript.rst b/tests/datasets/common/subscript.rst
@@ -1 +1,3 @@
+:orphan:
+
 This is :sub:`subscript`.
diff --git a/tests/datasets/common/superscript.rst b/tests/datasets/common/superscript.rst
@@ -1 +1,3 @@
+:orphan:
+
 This is :sup:`superscript`.
diff --git a/tests/datasets/directives/index.rst b/tests/datasets/directives/index.rst
@@ -1,2 +1,4 @@
+:orphan:
+
 This directory contains tests of general reStructuredText directives.
 See https://docutils.sourceforge.io/docs/ref/rst/directives.html
diff --git a/tests/datasets/index.rst b/tests/datasets/index.rst
@@ -1,4 +1,6 @@
-This folder contains expected test results.
+:orphan:
+
+This folder contains test sources.
 
 It is catagorized in directories:
 
diff --git a/tests/datasets/roles/index.rst b/tests/datasets/roles/index.rst
@@ -1,2 +1,4 @@
+:orphan:
+
 This directory contains tests of general reStructuredText roles.
 See https://docutils.sourceforge.io/docs/ref/rst/roles.html
diff --git a/tests/datasets/sphinx-directives/index.rst b/tests/datasets/sphinx-directives/index.rst
@@ -1,2 +1,4 @@
+:orphan:
+
 This directory contains tests of Sphinx-specific reStructuredText directives.
 See https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html
diff --git a/tests/datasets/sphinx-roles/index.rst b/tests/datasets/sphinx-roles/index.rst
@@ -1,2 +1,4 @@
+:orphan:
+
 This directory contains tests of Sphinx-specific reStructuredText roles.
 See https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html
diff --git a/tests/expected/common/bullet-list-consecutive.rst b/tests/expected/common/bullet-list-consecutive.rst
@@ -1,4 +1,5 @@
 - one
 - two
+
 * three
 * four
diff --git a/tests/expected/common/internal-hyperlinks.rst b/tests/expected/common/internal-hyperlinks.rst
@@ -5,8 +5,6 @@ below.
 
 The hyperlink target above points to this paragraph.
 
-Pointer to a nonexisting_ target.
-
 Titles are targets, too
 =======================
 
diff --git a/tests/expected/common/nonexistent-target.rst b/tests/expected/common/nonexistent-target.rst
@@ -0,0 +1 @@
+Pointer to a nonexisting_ target.
diff --git a/tests/expected/index.rst b/tests/expected/index.rst
@@ -1,4 +1,4 @@
-This folder contains test sources.
+This folder contains expected test results.
 
 It is catagorized in directories:
 
diff --git a/tests/test_rst_hyperlinks.py b/tests/test_rst_hyperlinks.py
@@ -13,6 +13,10 @@ def test_internal_hyperlinks(src_dir, expected_dir, output_dir):
     run_parse_test(src_dir, expected_dir, output_dir, 'common', ['internal-hyperlinks'])
 
 
+def test_nonexisting_target(src_dir, expected_dir, output_dir):
+    run_parse_test(src_dir, expected_dir, output_dir, 'common', ['nonexistent-target'])
+
+
 def test_ref(src_dir, expected_dir, output_dir):
     run_parse_test(src_dir, expected_dir, output_dir, 'sphinx-roles', ['ref'])
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`This is bold.`
-Original file line number
+Diff line change
@@ @@ -1,4 +1,7 @@ @@
 +:orphan:
++
 - one
 - two
++
 * three
 * four
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`First list:`
`2`	`4`
`3`	`5`	`- one`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`Definition lists:`
`2`	`4`
`3`	`5`	`what`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	Embedded external hyperlinks, like `Python
`2`	`4`	<https://www.python.org/>`_.
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`+---+---+`
`2`	`4`	`\| a \| b \|`
`3`	`5`	`+===+===+`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`Headline`
`2`	`4`	`========`
`3`	`5`	`Text immediately following.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`.. _target:`
`2`	`4`
`3`	`5`	`The hyperlink target above points to this paragraph.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+:orphan:`
	`2`	`+`
`1`	`3`	`Not indented`
`2`	`4`
`3`	`5`	`Four spaces`