-
Notifications
You must be signed in to change notification settings - Fork 1
39 lines (39 loc) · 1.1 KB
/
docs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
name: Build developer documentation
on:
push:
branches:
- main
jobs:
docs:
name: Build docs
runs-on: ubuntu-latest
# Ensure there are no conflicting pushes to GitHub Pages.
concurrency:
group: docs
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
submodules: recursive
- name: Install toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- name: Build the docs
uses: actions-rs/cargo@v1
with:
command: doc
# This is developer documentation: include crate-local symbols but
# don't build documentation for dependencies since it's unlikely to
# be useful.
args: --document-private-items --no-deps
- name: Publish to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./target/doc/
destination_dir: docs
force_orphan: true