Skip to content

Commit de16431

Browse files
committed
docs(AGENTS[testing]): integration marker applies to all Sphinx-app tests
why: The original wording ("Must verify actual HTML output or Sphinx event wiring") left room to argue that buildername="dummy" tests aren't really integration. During this branch's review, 13 such tests were authored without @pytest.mark.integration because "dummy" sounded lightweight enough to skip the marker. Tightening the rule closes the loophole — if the test instantiates a Sphinx app, it's integration, regardless of builder. what: - Rewrite the Sphinx-integration row of the Test Level Hierarchy table in AGENTS.md to name build_shared_sphinx_result / build_isolated_sphinx_result explicitly and call out the dummy-builder case so future authors don't have to re-litigate it.
1 parent 07f5858 commit de16431

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ test runs in microseconds.
170170
| **Pure unit** | Transforming strings, dicts, dataclasses — no nodes, no Sphinx |
171171
| **Docutils tree unit** | Testing transforms/visitors/renderers by constructing `nodes.*` directly |
172172
| **Snapshot unit** | Same as docutils tree, but output is large or complex — assert via `snapshot_doctree` |
173-
| **Sphinx integration** (`@pytest.mark.integration`) | Must verify actual HTML output or Sphinx event wiring |
173+
| **Sphinx integration** (`@pytest.mark.integration`) | **Any test that constructs a `Sphinx` app.** `build_shared_sphinx_result` / `build_isolated_sphinx_result` with any builder — *including `buildername="dummy"`* — counts. If the test touches `env.domains.*`, walks a built doctree, or asserts on `result.warnings`, it is integration. |
174174

175175
### Type Annotations (required everywhere)
176176

0 commit comments

Comments
 (0)