Skip to content

Commit f22e427

Browse files
committed
CHANGES(docs): Document PR #337 features for 0.32.x release
1 parent 0ef0318 commit f22e427

1 file changed

Lines changed: 28 additions & 1 deletion

File tree

CHANGES

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,19 @@ $ uvx --from 'cihai-cli' --prerelease allow cihai
3232

3333
<!-- Maintainers, insert changes / features for the next release here -->
3434

35-
- _Changes for the upcoming release go here._
35+
### What's new
36+
37+
#### Colored CLI help output (#337)
38+
39+
- Add syntax highlighting for CLI help examples
40+
- New `_colors.py` module with ANSI color support respecting `NO_COLOR`/`FORCE_COLOR`
41+
- New `_formatter.py` with custom argparse HelpFormatter for colored examples
42+
43+
### Packaging
44+
45+
- Add `py.typed` marker for [PEP 561] type checking support (#337)
46+
47+
[PEP 561]: https://peps.python.org/pep-0561/
3648

3749
### Development
3850

@@ -41,6 +53,21 @@ $ uvx --from 'cihai-cli' --prerelease allow cihai
4153
- Migrate from `Makefile` to `justfile` for running development tasks
4254
- Update documentation to reference `just` commands
4355

56+
#### Replace sphinx-argparse with sphinx_argparse_neo (#337)
57+
58+
- Port `sphinx_argparse_neo` extension from vcspull, replacing external `sphinx-argparse` dependency
59+
- Add custom Pygments lexers for argparse and CLI usage syntax highlighting:
60+
- `argparse_lexer.py` - Lexer for argparse help text
61+
- `cli_usage_lexer.py` - Lexer for CLI usage patterns
62+
- Add `argparse_exemplar.py` extension for transforming argparse epilog examples into documentation
63+
- Add `argparse_roles.py` for custom Sphinx roles (`:opt:`, `:arg:`, `:prog:`)
64+
- Add CSS styling for syntax-highlighted argparse output
65+
- Add comprehensive test suite for all Sphinx extensions
66+
67+
#### Dev dependencies
68+
69+
- Add `types-docutils` and `types-Pygments` for type checking Sphinx extensions (#337)
70+
4471
### Documentation
4572

4673
- Migrate docs deployment to AWS OIDC authentication and AWS CLI

0 commit comments

Comments
 (0)