mirror of
https://github.com/gfx-rs/wgpu.git
synced 2025-12-08 21:26:17 +00:00
d81cb46be0
* enable doc_auto_cfg for docs.rs This should expose more feature labels in the generated documentation and removes the needs for the manually labeling the features for a type, function or enum variants. * enable docsrs cfg when building docs for master
47 lines
1.1 KiB
YAML
47 lines
1.1 KiB
YAML
name: Documentation
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout the code
|
|
uses: actions/checkout@v2
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Install latest nightly
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
toolchain: nightly
|
|
override: true
|
|
continue-on-error: true
|
|
|
|
- name: Add EGL for OpenGL
|
|
run: |
|
|
sudo apt-get update -y -qq
|
|
sudo apt-get install -y -qq libegl1-mesa-dev
|
|
|
|
- name: Build the docs (nightly)
|
|
run: |
|
|
cargo +nightly doc --no-deps --lib
|
|
env: RUSTDOCFLAGS="--cfg docsrs"
|
|
|
|
- name: Build the docs (stable)
|
|
run: cargo +stable doc --no-deps --lib
|
|
if: ${{ failure() }}
|
|
|
|
- name: Deploy the docs
|
|
uses: JamesIves/github-pages-deploy-action@releases/v3
|
|
with:
|
|
ACCESS_TOKEN: ${{ secrets.WEB_DEPLOY }}
|
|
FOLDER: target/doc
|
|
REPOSITORY_NAME: gfx-rs/wgpu-rs.github.io
|
|
BRANCH: master
|
|
TARGET_FOLDER: doc
|