Skip to content

Commit

Permalink
docs: generate usage docs in actions via xtask (#249)
Browse files Browse the repository at this point in the history
  • Loading branch information
reubeno authored Oct 27, 2024
1 parent 4676c66 commit a7d77ff
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,40 @@ jobs:
with:
args: ". --offline --verbose --no-progress"
fail: true

# Generate docs content
generate-docs:
name: "Generate usage docs"
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable

- name: Enable cargo cache
uses: Swatinem/rust-cache@v2

- name: Create dirs
run: mkdir -p ./md ./man

- name: Build markdown info
run: cargo xtask generate-markdown --out ./md/brush.md

- name: Upload markdown docs
uses: actions/upload-artifact@v4
with:
name: docs-markdown
path: md

- name: Build man pages
run: cargo xtask generate-man --output-dir ./man

- name: Upload man pages
uses: actions/upload-artifact@v4
with:
name: docs-man
path: man

0 comments on commit a7d77ff

Please sign in to comment.