feat(main): rename docs file #2
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
name: Build manual pages and deploy documentation | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- 'src/cli.rs' | |
- 'doctave.yml' | |
- '.github/workflows/deploy-docs.yaml' | |
- 'build_manuals.sh' | |
- 'roff_to_md.sh' | |
- 'prelude' | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: 'Checkout cargo and install doctave' | |
uses: actions-rs/toolchain@v1 | |
with: | |
toolchain: stable | |
- run: cargo install --git https://github.com/Doctave/doctave --tag 0.4.2 | |
- name: 'Build manual pages' | |
run: bash build_manuals.sh | |
- name: 'Convert to markdown: recover' | |
uses: docker://pandoc/core:2.9 | |
with: | |
args: -t markdown -f man --output=docs/usage/rosella-recover.wd.md docs/usage/rosella-recover.wd.roff | |
- name: 'Convert to markdown: refine' | |
uses: docker://pandoc/core:2.9 | |
with: | |
args: -t markdown -f man --output=docs/usage/rosella-refine.wd.md docs/usage/rosella-refine.wd.roff | |
- name: 'Cleanup markdown' | |
run: bash roff_to_md.sh | |
- name: 'Build doctave site' | |
run: doctave build --release --allow-failed-checks | |
- name: 'GitHub Pages' | |
if: github.ref == 'refs/heads/master' | |
uses: crazy-max/[email protected] | |
with: | |
build_dir: site/ | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |