Skip to content

Commit 67d2231

Browse files
committed
docs(changes): Add changelog entries for PR #1009
Document sphinx_argparse_neo migration and related fixes for v1.64.0.
1 parent 7f34252 commit 67d2231

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

CHANGES

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,28 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
3131

3232
<!-- To maintainers and contributors: Please add notes for the forthcoming version below -->
3333

34-
_Notes on the upcoming release will go here._
34+
### Documentation
35+
36+
#### CLI documentation overhaul with sphinx_argparse_neo (#1009)
37+
38+
Replaced the `pretty_argparse` extension with a new `sphinx_argparse_neo` package:
39+
40+
- **New argparse documentation engine**: Complete rewrite for cleaner, more maintainable CLI docs
41+
- **Syntax highlighting**: Custom Pygments lexers for CLI usage blocks and argparse output
42+
- **Examples transformation**: Automatically converts epilog "examples:" definition lists into proper documentation sections with TOC entries
43+
- **ANSI stripping**: Removes escape codes when `FORCE_COLOR` is set
44+
- **RST emphasis escaping**: Prevents warnings from glob patterns like `django-*`
45+
- **Restructured CLI pages**: Consistent layout matching vcspull documentation pattern
46+
47+
### Bug fixes
48+
49+
#### Docutils node.children protocol (#1009)
50+
51+
- Fixed direct `node.children` assignment that bypassed docutils' parent-child tracking mechanism
52+
53+
#### Mypy type annotation (#1009)
54+
55+
- Added missing type annotation to fix `no-any-return` error
3556

3657
## tmuxp 1.63.1 (2026-01-11)
3758

0 commit comments

Comments
 (0)