docs: Generate docs/man #233
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This will help motivate us to improve our man pages, by making them much more visible as pre-generated markdown that can be conveniently viewed from e.g. the Github web UI. For now, anytime we change the CLI we'll need to manually run `cargo xtask man2markdown`, and commit and push the result. This requires `pandoc` in the environment. If this becomes burdensome I will likely investigate doing e.g. a Github action which either automates doing it post-commit, or enforces that it's done as part of the commit which introduces the change. However the problem with the latter will be the `pandoc` requirement. It may make sense to investigate e.g. [clap-markdown](https://docs.rs/clap-markdown/latest/clap_markdown/) in the future instead. Signed-off-by: Colin Walters <walters@verbum.org>
jmarrero
approved these changes
Dec 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will help motivate us to improve our man pages, by making them much more visible as pre-generated markdown that can be conveniently viewed from e.g. the Github web UI.
For now, anytime we change the CLI we'll need to manually run
cargo xtask man2markdown, and commit and push the result. This requirespandocin the environment.If this becomes burdensome I will likely investigate doing e.g. a Github action which either automates doing it post-commit, or enforces that it's done as part of the commit which introduces the change. However the problem with the latter will be the
pandocrequirement.It may make sense to investigate e.g.
clap-markdown in the future instead.