Skip to content

CI: Add workflow for documentation generation #71

CI: Add workflow for documentation generation

CI: Add workflow for documentation generation #71

Workflow file for this run

name: Generate and Preview Rust Docs
on:
pull_request:
branches:
- main # Only generate docs for PRs targeting main
push:
branches:
- main
workflow_dispatch:
permissions:
contents: read
jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
path: zephyr-rust-lang
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Setup Zephyr project
uses: zephyrproject-rtos/action-zephyr-setup@v1
with:
app-path: zephyr-rust-lang
manifest-file-name: ci-manifest.yml
toolchains: arm-zephyr-eabi:riscv64-zephyr-elf
- name: Install Rust Targets
shell: bash
run: |
rustup target add thumbv7em-none-eabi
rustup target add thumbv7m-none-eabi
- name: Build Rust documentation
working-directory: zephyr-rust-lang
run: |
# Note that the above build doesn't set Zephyrbase, so we'll need to do that here.
west build -t rustdoc -b nrf52840dk/nrf52840 docgen
mkdir rustdocs
mv build/rust/target/thumbv7em-none-eabi/doc rustdocs/nostd
cp docs/top-index.html rustdocs/index.html
- name: Build build documentation
working-directory: zephyr-rust-lang
run: |
cd zephyr-build
cargo doc
mv target/doc ../rustdocs/std
- name: Compress docs
working-directory: zephyr-rust-lang
run: |
tar --use-compress-program="xz -T0" -cf rustdocs.tar.xz rustdocs
- name: Upload docs artifact
uses: actions/upload-artifact@v4
with:
name: rustdocs
path: zephyr-rust-lang/rustdocs.tar.xz