Skip to content

Commit

Permalink
simplify cli doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfv committed Oct 8, 2024
1 parent 655c5b5 commit f338cf8
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 4 deletions.
1 change: 0 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ jobs:

- name: Build docs for PR
run: |
sed -i '/\[dependencies\]/a clap-markdown = { git = "https://github.com/ruben-arts/clap-markdown", branch = "main" }' Cargo.toml
pixi run generate-cli-docs
- name: Check for changes
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ tui = [
'tui-input',
]
recipe-generation = ['rattler_installs_packages']
# This feature needs to add a dependency on
# This feature needs to add a dependency on
# clap-markdown = { git = "https://github.com/ruben-arts/clap-markdown", branch = "main" }
# but in order to be able to publish to crates we remove this feature
generate-cli-docs = []
Expand Down
2 changes: 1 addition & 1 deletion pixi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ install = "cargo install --path . --locked"
end_to_end_test = "pytest test/end-to-end --snapshot-warn-unused --snapshot-details"
test = "cargo test"
lint = "pre-commit run --all"
generate-cli-docs = "cargo run --bin generate-cli-docs --features generate-cli-docs > docs/reference/cli.md"
generate-cli-docs = "cargo add clap-markdown --git https://github.com/ruben-arts/clap-markdown --branch main && cargo run --bin generate-cli-docs --features generate-cli-docs > docs/reference/cli.md && cargo rm clap-markdown"
update-snapshots = "pytest test/end-to-end --snapshot-update"

[feature.docs.tasks]
Expand Down
2 changes: 1 addition & 1 deletion test-data/recipes/env_vars/variants.yaml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
MAKEFLAGS:
- OVERRIDDEN_MAKEFLAGS
- OVERRIDDEN_MAKEFLAGS

0 comments on commit f338cf8

Please sign in to comment.