Skip to content

Commit efdc2d7

Browse files
committed
docs(whats-new): add argparse-domain advancement; bump counts
why: The What's New page counted seven advancements and the "Shared layout stack" section listed five domain packages. The argparse domain that landed in the recent seven-commit series (a real Sphinx Domain subclass with :argparse:* roles and two auto-generated indices) is a peer advancement that the page did not yet describe. Update the counts and introduce the new section so readers arriving via the sidebar's "What's new" card see the whole picture. what: - Opening line: "seven major advancements" -> "eight". - "Shared layout stack" section: "The five domain packages" -> "The six domain packages"; add argparse to the {doc} list, alphabetically between api-style and docutils. - Insert a new "## argparse Sphinx domain" section between "Shared layout stack" and "Three-tier package organization". Describes the Domain subclass, the four :argparse:* xref roles, the two auto-generated indices (argparse-programsindex, argparse-optionsindex), and the intersphinx compatibility contract with :option: / std:cmdoption.
1 parent 587637c commit efdc2d7

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

docs/whats-new.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# What's new
44

55
The `autodoc-improvements` branch introduces a unified **autodoc design
6-
system**seven major advancements that transform how the documentation
6+
system**eight major advancements that transform how the documentation
77
stack works. See the {doc}`gallery` for a visual showcase.
88

99
## New packages
@@ -27,8 +27,9 @@ light/dark theming.
2727

2828
## Shared layout stack
2929

30-
The five domain packages
30+
The six domain packages
3131
({doc}`api-style <packages/sphinx-autodoc-api-style>`,
32+
{doc}`argparse <packages/sphinx-autodoc-argparse>`,
3233
{doc}`docutils <packages/sphinx-autodoc-docutils>`,
3334
{doc}`fastmcp <packages/sphinx-autodoc-fastmcp>`,
3435
{doc}`pytest-fixtures <packages/sphinx-autodoc-pytest-fixtures>`,
@@ -37,6 +38,18 @@ now all share the same layout, badge, and typehint infrastructure. A
3738
change in the foundational layout package propagates instantly and
3839
consistently.
3940

41+
## argparse Sphinx domain
42+
43+
{doc}`sphinx-autodoc-argparse <packages/sphinx-autodoc-argparse>` now
44+
ships a real Sphinx `Domain` subclass. Programs, options, subcommands,
45+
and positional arguments are individually addressable via
46+
`:argparse:program:`, `:argparse:option:`, `:argparse:subcommand:`, and
47+
`:argparse:positional:` xref roles. Two auto-generated indices —
48+
`argparse-programsindex` (alphabetised programs) and
49+
`argparse-optionsindex` (options grouped by program) — give a workspace
50+
overview. `:option:` / `std:cmdoption` continues to resolve for
51+
intersphinx consumers.
52+
4053
## Three-tier package organization
4154

4255
The workspace has been restructured into a clear {doc}`three-tier

0 commit comments

Comments
 (0)