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 68 69 70 71 72 73 74 75 76 77
|
from __future__ import annotations
import os
from pathlib import Path
from sphinx import version_info
from sphinx.testing.util import SphinxTestApp
def test_file_registration(tmp_path: Path, make_app: type[SphinxTestApp]):
"""
Tests a build via the Sphinx Build API.
"""
src_dir = os.path.join(os.path.dirname(__file__), "../doc_test/doc_style_modern")
if version_info >= (7, 2):
src_dir = Path(src_dir)
else:
from sphinx.testing.path import path
src_dir = path(src_dir)
tmp_path = path(str(tmp_path))
sphinx_app = make_app(
srcdir=src_dir,
builddir=tmp_path,
buildername="html",
parallel=4,
)
# 1. Build
sphinx_app.build()
# Only check Sphinx-Needs files
css_files = [
x
for x in sphinx_app.builder.css_files
if x.filename.startswith("_static/sphinx-needs")
]
script_files = [
x
for x in sphinx_app.builder.script_files
if x.filename.startswith("_static/sphinx-needs")
]
css_run_1 = len(css_files)
script_run_1 = len(script_files)
# Check for duplicates
assert css_run_1 == len(set(css_files))
assert script_run_1 == len(set(script_files))
assert sphinx_app.statuscode == 0
# 2. Build
sphinx_app.build()
# Only check Sphinx-Needs files
css_files = [
x
for x in sphinx_app.builder.css_files
if x.filename.startswith("_static/sphinx-needs")
]
script_files = [
x
for x in sphinx_app.builder.script_files
if x.filename.startswith("_static/sphinx-needs")
]
css_run_2 = len(css_files)
script_run_2 = len(script_files)
# Check for duplicates
assert css_run_2 == len(set(css_files))
assert script_run_2 == len(set(script_files))
assert sphinx_app.statuscode == 0
assert css_run_1 == css_run_2
assert script_run_1 == script_run_2
|