summaryrefslogtreecommitdiffstats
path: root/tests/test_directive_other.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_directive_other.py')
-rw-r--r--tests/test_directive_other.py195
1 files changed, 195 insertions, 0 deletions
diff --git a/tests/test_directive_other.py b/tests/test_directive_other.py
new file mode 100644
index 0000000..1feb251
--- /dev/null
+++ b/tests/test_directive_other.py
@@ -0,0 +1,195 @@
+"""Test the other directives."""
+from pathlib import Path
+
+import pytest
+from docutils import nodes
+
+from sphinx import addnodes
+from sphinx.testing import restructuredtext
+from sphinx.testing.util import assert_node
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_toctree(app):
+ text = (".. toctree::\n"
+ "\n"
+ " foo\n"
+ " bar/index\n"
+ " baz\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'foo'), (None, 'bar/index'), (None, 'baz')],
+ includefiles=['foo', 'bar/index', 'baz'])
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_relative_toctree(app):
+ text = (".. toctree::\n"
+ "\n"
+ " bar_1\n"
+ " bar_2\n"
+ " bar_3\n"
+ " ../quux\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'bar/index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'bar/bar_1'), (None, 'bar/bar_2'), (None, 'bar/bar_3'),
+ (None, 'quux')],
+ includefiles=['bar/bar_1', 'bar/bar_2', 'bar/bar_3', 'quux'])
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_toctree_urls_and_titles(app):
+ text = (".. toctree::\n"
+ "\n"
+ " Sphinx <https://www.sphinx-doc.org/>\n"
+ " https://readthedocs.org/\n"
+ " The BAR <bar/index>\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[('Sphinx', 'https://www.sphinx-doc.org/'),
+ (None, 'https://readthedocs.org/'),
+ ('The BAR', 'bar/index')],
+ includefiles=['bar/index'])
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_toctree_glob(app):
+ text = (".. toctree::\n"
+ " :glob:\n"
+ "\n"
+ " *\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'baz'), (None, 'foo'), (None, 'quux')],
+ includefiles=['baz', 'foo', 'quux'])
+
+ # give both docname and glob (case1)
+ text = (".. toctree::\n"
+ " :glob:\n"
+ "\n"
+ " foo\n"
+ " *\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'foo'), (None, 'baz'), (None, 'quux')],
+ includefiles=['foo', 'baz', 'quux'])
+
+ # give both docname and glob (case2)
+ text = (".. toctree::\n"
+ " :glob:\n"
+ "\n"
+ " *\n"
+ " foo\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'baz'), (None, 'foo'), (None, 'quux'), (None, 'foo')],
+ includefiles=['baz', 'foo', 'quux', 'foo'])
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_toctree_glob_and_url(app):
+ text = (".. toctree::\n"
+ " :glob:\n"
+ "\n"
+ " https://example.com/?q=sphinx\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'https://example.com/?q=sphinx')],
+ includefiles=[])
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_reversed_toctree(app):
+ text = (".. toctree::\n"
+ " :reversed:\n"
+ "\n"
+ " foo\n"
+ " bar/index\n"
+ " baz\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'baz'), (None, 'bar/index'), (None, 'foo')],
+ includefiles=['baz', 'bar/index', 'foo'])
+
+
+@pytest.mark.sphinx(testroot='toctree-glob')
+def test_toctree_twice(app):
+ text = (".. toctree::\n"
+ "\n"
+ " foo\n"
+ " foo\n")
+
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, [nodes.document, nodes.compound, addnodes.toctree])
+ assert_node(doctree[0][0],
+ entries=[(None, 'foo'), (None, 'foo')],
+ includefiles=['foo', 'foo'])
+
+
+@pytest.mark.sphinx(testroot='directive-include')
+def test_include_include_read_event(app):
+ sources_reported = []
+
+ def source_read_handler(_app, relative_path, parent_docname, source):
+ sources_reported.append((relative_path, parent_docname, source[0]))
+
+ app.connect("include-read", source_read_handler)
+ text = """\
+.. include:: baz/baz.rst
+ :start-line: 4
+.. include:: text.txt
+ :literal:
+.. include:: bar.txt
+"""
+ app.env.find_files(app.config, app.builder)
+ restructuredtext.parse(app, text, 'index')
+
+ included_files = {filename.as_posix()
+ for filename, p, s in sources_reported}
+ assert 'index.rst' not in included_files # sources don't emit 'include-read'
+ assert 'baz/baz.rst' in included_files
+ assert 'text.txt' not in included_files # text was included as literal, no rst parsing
+ assert 'bar.txt' in included_files # suffix not in source-suffixes
+ assert (Path('baz/baz.rst'), 'index', '\nBaz was here.') in sources_reported
+
+
+@pytest.mark.sphinx(testroot='directive-include')
+def test_include_include_read_event_nested_includes(app):
+
+ def source_read_handler(_app, _relative_path, _parent_docname, source):
+ text = source[0].replace("#magical", "amazing")
+ source[0] = text
+
+ app.connect("include-read", source_read_handler)
+ text = ".. include:: baz/baz.rst\n"
+ app.env.find_files(app.config, app.builder)
+ doctree = restructuredtext.parse(app, text, 'index')
+ assert_node(doctree, addnodes.document)
+ assert len(doctree.children) == 3
+ assert_node(doctree.children[1], nodes.paragraph)
+ assert doctree.children[1].rawsource == "The amazing foo."
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-05 08:05:18 +0000