File: test_docutilsconf.py

package info (click to toggle)
sphinx 9.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 28,732 kB
  • sloc: python: 109,394; javascript: 37,318; perl: 449; makefile: 183; sh: 37; xml: 19; ansic: 2
file content (50 lines) | stat: -rw-r--r-- 1,278 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
"""Test docutils.conf support for several writers."""

from __future__ import annotations

from typing import TYPE_CHECKING

import pytest
from docutils import nodes

from sphinx.testing.util import assert_node
from sphinx.util.docutils import patch_docutils

if TYPE_CHECKING:
    from sphinx.application import Sphinx


@pytest.mark.sphinx(
    'dummy',
    testroot='docutilsconf',
    freshenv=True,
)
def test_html_with_default_docutilsconf(app: Sphinx) -> None:
    with patch_docutils(app.confdir):
        app.build()

    doctree = app.env.get_doctree('index')
    section = doctree[0]
    assert isinstance(section, nodes.Element)
    assert_node(
        section[1], [nodes.paragraph, ('Sphinx ', [nodes.footnote_reference, '1'])]
    )


@pytest.mark.sphinx(
    'dummy',
    testroot='docutilsconf',
    freshenv=True,
    docutils_conf='[restructuredtext parser]\ntrim_footnote_reference_space: true\n',
    copy_test_root=True,
)
def test_html_with_docutilsconf(app: Sphinx) -> None:
    with patch_docutils(app.confdir):
        app.build()

    doctree = app.env.get_doctree('index')
    section = doctree[0]
    assert isinstance(section, nodes.Element)
    assert_node(
        section[1], [nodes.paragraph, ('Sphinx', [nodes.footnote_reference, '1'])]
    )