Commit 18695da
committed
docs(feat[requirements]): document sphinx 8.1+ floor and typed domain idiom
why: Record the new Sphinx 8.1+ workspace floor where contributors
and downstream users look for it, and codify the typed-accessor
convention so the `env.get_domain(<literal>)` / `t.cast` pattern does
not creep back in. CLAUDE.md is a symlink to AGENTS.md so both
surfaces update in one edit.
what:
- AGENTS.md: add `Sphinx 8.1+` to the Development Environment list;
add a new `Sphinx domain access` Coding-Standards subsection
explaining `env.domains.<name>_domain` and listing the core
typed accessors
- README.md: add a top-level `Requirements` section (Python 3.10+,
Sphinx 8.1+) above the install instructions
- packages/sphinx-autodoc-fastmcp/README.md: tighten the
`Dependencies` list entry from `Sphinx` to `Sphinx 8.1+`1 parent 5f10760 commit 18695da
3 files changed
Lines changed: 23 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
29 | 30 | | |
30 | 31 | | |
31 | 32 | | |
| |||
448 | 449 | | |
449 | 450 | | |
450 | 451 | | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
451 | 468 | | |
452 | 469 | | |
453 | 470 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
7 | 12 | | |
8 | 13 | | |
9 | 14 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| |||
0 commit comments