Skip to content

Provide manpages #921

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 53 commits into from
Oct 15, 2025
Merged

Provide manpages #921

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
7e272e1
Experiment: Use mdbook to create manpages for Topiary CLI
Xophmeister Mar 21, 2025
17170ac
Setup Cargo for mdbook-manmunge
Xophmeister Mar 26, 2025
7004edf
CLI for mdbook-manmunge
Xophmeister Mar 26, 2025
52ee07c
Separate README for mdbook-manmunge
Xophmeister Mar 26, 2025
d2f2899
Noop preprocessor
Xophmeister Mar 27, 2025
2c07f8f
Move mdbook-manmunge into docs/manpages and hook up
Xophmeister Mar 27, 2025
071b7be
Remove relative and unparsable links
Xophmeister Mar 27, 2025
fe5e901
Use logging, rather eprintln
Xophmeister Mar 28, 2025
56c2af7
Use filter_map so the event stream can be manipulated
Xophmeister Mar 28, 2025
596d31c
Order subcommand chapters in the same order as topiary --help
Xophmeister Mar 31, 2025
6c3b755
Strip H1 headings
Xophmeister Mar 31, 2025
b1e133c
We're going to need flat_map so we can rewrite sequences of events
Xophmeister Mar 31, 2025
3f70280
Correct for hard wrapping in input
Xophmeister Mar 31, 2025
9fb21e9
WIP: Verbatim structure (tables and lists) preprocessing
Xophmeister Apr 4, 2025
29d3dea
Increment ordered lists in verbatim output
Xophmeister Apr 7, 2025
5a6a722
Escape backslashes
Xophmeister Apr 7, 2025
cb68983
Distinguish between ordered and unordered lists in logging
Xophmeister Apr 7, 2025
fb41a27
WIP: Generic verbatim writer
Xophmeister Apr 8, 2025
57f0808
Error propagation
Xophmeister Apr 8, 2025
fd4fc99
Switch to trait-based verbatim renderer
Xophmeister Apr 9, 2025
80fe964
[WIP] Table rendering
Xophmeister May 12, 2025
0e07f8a
Simplify verbatim error handling
Xophmeister May 13, 2025
a3b69ab
Decouple table implementation from building
Xophmeister May 13, 2025
666f5a5
API to get data into and out of the table
Xophmeister May 13, 2025
975a42b
Use Cmark type for table cell buffer
Xophmeister May 16, 2025
64fcfc9
Expanded doc-comment for CmarkTable
Xophmeister May 16, 2025
ae3d0b1
Simple Makefile to build the final manpage
Xophmeister May 19, 2025
e84f44d
manpage README and installation in Makefile
Xophmeister May 19, 2025
fcdff8d
Added to CHANGELOG
Xophmeister May 19, 2025
316a035
Centralise error handling
Xophmeister May 20, 2025
a1c14fc
Simple post-processor
Xophmeister May 21, 2025
0dfe330
WIP: Consume table events
Xophmeister May 23, 2025
73daae4
Verbatim::consume now returns Result<(), Error>
Xophmeister May 23, 2025
c38c389
Complete and hook-up verbatim table renderer
Xophmeister May 23, 2025
d9db9f2
More efficient backslash escaping
Xophmeister May 27, 2025
6c41d0e
Note about hardcoding
Xophmeister May 27, 2025
fe7c74e
Tests for verbatim rendering
Xophmeister Jun 5, 2025
58a7143
Add mdbook-manmunge to Nix Topiary packages
Xophmeister Jun 6, 2025
ce2e7ea
Update manpage build to assume mdbook-manpage is available on $PATH
Xophmeister Jun 6, 2025
0b0dcd5
Add topiary-manpages to Nix Topiary packages
Xophmeister Jun 6, 2025
0d9cbe4
Remove unnecessary code
Xophmeister Jun 7, 2025
91c5a35
Fix formatting
Xophmeister Jun 7, 2025
a66d4f3
Tighten up Makefile and derivation
Xophmeister Jun 7, 2025
1b4955e
Add mdbook-man to Nix devshell
Xophmeister Jun 18, 2025
5d7f2bf
Improve README
Xophmeister Jun 18, 2025
0fb7e40
Document installation instructions for mdbook-man
Xophmeister Jun 18, 2025
655b794
Note about mismatched version warning
Xophmeister Jun 18, 2025
211468b
Merge branch 'main' into chris/book/manpages
Xophmeister Sep 22, 2025
784ae06
Add explanation to Escape::escape_backslashes
Xophmeister Oct 8, 2025
d1e2577
Updated Cow annotations
Xophmeister Oct 8, 2025
362c08f
Made Makefile BSD-proof and defaulted install to ~/.local
Xophmeister Oct 8, 2025
c899148
Merge branch 'main' into chris/book/manpages
Xophmeister Oct 15, 2025
74b8ed4
Fixed formatting
Xophmeister Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ This name should be decided amongst the team before the release.
[Full list of changes](https://github.com/tweag/topiary/compare/v0.6.1...HEAD)

### Added
- [#921](https://github.com/tweag/topiary/pull/921) man pages for the Topiary CLI
- [#1015](https://github.com/tweag/topiary/pull/1015) Add support for include expressions to Nickel formatting
- [#1049](https://github.com/tweag/topiary/pull/1015) Add support for rich grammar parsing errors using miette
- [#1069](https://github.com/tweag/topiary/pull/1069) split CI nix dependent tests into separate jobs
Expand Down
Loading