File: test_build_dirhtml.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 (67 lines) | stat: -rw-r--r-- 2,069 bytes parent folder | download | duplicates (10)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
"""Test dirhtml builder."""

from __future__ import annotations

import posixpath
from typing import TYPE_CHECKING

import pytest

from sphinx.util.inventory import InventoryFile, _InventoryItem

if TYPE_CHECKING:
    from sphinx.testing.util import SphinxTestApp


@pytest.mark.sphinx('dirhtml', testroot='builder-dirhtml')
def test_dirhtml(app: SphinxTestApp) -> None:
    app.build()

    assert (app.outdir / 'index.html').exists()
    assert (app.outdir / 'foo/index.html').exists()
    assert (app.outdir / 'foo/foo_1/index.html').exists()
    assert (app.outdir / 'foo/foo_2/index.html').exists()
    assert (app.outdir / 'bar/index.html').exists()

    content = (app.outdir / 'index.html').read_text(encoding='utf8')
    assert 'href="foo/"' in content
    assert 'href="foo/foo_1/"' in content
    assert 'href="foo/foo_2/"' in content
    assert 'href="bar/"' in content

    # objects.inv
    # See: https://github.com/sphinx-doc/sphinx/issues/7095
    with (app.outdir / 'objects.inv').open('rb') as f:
        invdata = InventoryFile.load(f, 'path/to', posixpath.join)

    assert 'index' in invdata.get('std:doc', {})
    assert invdata['std:doc']['index'] == _InventoryItem(
        project_name='Project name not set',
        project_version='',
        uri='path/to/',
        display_name='-',
    )

    assert 'foo/index' in invdata.get('std:doc', {})
    assert invdata['std:doc']['foo/index'] == _InventoryItem(
        project_name='Project name not set',
        project_version='',
        uri='path/to/foo/',
        display_name='-',
    )

    assert 'index' in invdata.get('std:label', {})
    assert invdata['std:label']['index'] == _InventoryItem(
        project_name='Project name not set',
        project_version='',
        uri='path/to/#index',
        display_name='-',
    )

    assert 'foo' in invdata.get('std:label', {})
    assert invdata['std:label']['foo'] == _InventoryItem(
        project_name='Project name not set',
        project_version='',
        uri='path/to/foo/#foo',
        display_name='foo/index',
    )