Skip to content

Documentation

Documentation #150

Workflow file for this run

---
name: Documentation
"on":
push:
branches:
- trunk
pull_request:
branches:
- trunk
schedule:
- cron: "0 0 * * TUE"
concurrency:
group: docs-${{ github.head_ref }}
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
jobs:
rustdoc:
name: Build Rust API docs
runs-on: windows-latest
env:
RUSTDOCFLAGS: -D warnings -D rustdoc::broken_intra_doc_links --cfg docsrs
RUST_BACKTRACE: 1
steps:
# https://github.com/actions/checkout/issues/135
- name: Setup git line ending checkout behavior
shell: bash
if: runner.os == 'Windows'
run: |
git config --system core.autocrlf false
git config --system core.eol lf
- name: Checkout repository
uses: actions/checkout@v4.1.4
- name: Install Rust toolchain
uses: artichoke/setup-rust/rustdoc@v1.11.0
- name: Check docs with no default features
run: cargo doc --workspace --no-default-features
- name: Clean docs
run: cargo clean
- name: Build Documentation
run: cargo doc --workspace
- name: Deploy Docs
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v3.9.2
if: github.ref == 'refs/heads/trunk'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
publish_branch: gh-pages
user_name: artichoke-ci
user_email: ci@artichokeruby.org
# only have the most recent docs in the `gh-pages` branch
# https://github.com/artichoke/artichoke/issues/1826
force_orphan: true