docs: intial implementation based on rustdoc and mermaid #5
Workflow file for this run
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: | |
pull_request: | |
paths-ignore: | |
- 'docker/**' | |
- 'infra/**' | |
- 'js/**' | |
- 'scripts/**' | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install dependencies | |
run: sudo apt-get update && sudo apt-get install -y protobuf-compiler | |
- name: Checkout sources | |
uses: actions/checkout@v4 | |
- name: Install rust toolchain | |
run : rustup show | |
- name: Build docs | |
run: cargo doc --no-deps --document-private-items --workspace | |
- name: Upload tester | |
uses: actions/upload-artifact@v4 | |
with: | |
name: docs | |
if-no-files-found: error | |
path: target/doc |