Improve top-level README's GettingStarted
section
#180
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: "Generate Docs" | |
on: | |
push: | |
branches: ["main"] | |
pull_request: | |
types: [opened, synchronize, reopened] | |
workflow_dispatch: | |
workflow_call: | |
inputs: | |
workflow: | |
required: true | |
type: string | |
env: | |
REV: ${{ github.run_id }} | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }}-${{ inputs.workflow }} | |
cancel-in-progress: true | |
jobs: | |
aranya-client-capi-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: ./.github/actions/setup | |
- name: Generate Doxygen docs | |
run: | | |
cargo make build-capi-docs | |
cargo make tgz-capi-docs | |
- name: Publish Doxygen docs | |
uses: actions/upload-artifact@v4 | |
with: | |
name: aranya-client-capi-docs | |
path: aranya-client-capi-docs.tar.gz | |
if-no-files-found: error | |
aranya-rust-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: ./.github/actions/setup | |
- name: Generate docs | |
env: | |
RUSTDOCFLAGS: "-Dwarnings" | |
run: | | |
cargo make gen-docs-nightly |