Skip to content

[graphql/rpc] Auto create markdown doc from examples (#14492) #1

[graphql/rpc] Auto create markdown doc from examples (#14492)

[graphql/rpc] Auto create markdown doc from examples (#14492) #1

Workflow file for this run

name: Docs
on:
push:
branches:
- main
paths:
- "**.rs"
- "Cargo.toml"
- "Cargo.lock"
workflow_dispatch:
jobs:
docs:
name: Generate crate documentation
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@e2f20e631ae6d7dd3b768f56a5d2af784dd54791 # pin@v2
- name: Install Rust toolchain
uses: actions-rs/toolchain@v1
with:
profile: minimal
# Upgrade below after the workspace upgrades to Rust 1.72 or later.
# https://substrate.stackexchange.com/a/9069
toolchain: nightly-2023-06-15
override: true
- name: Generate documentation
uses: actions-rs/cargo@844f36862e911db73fe0815f00a4a2602c279505 # pin@v1
env:
RUSTDOCFLAGS: "--enable-index-page -Zunstable-options"
with:
command: doc
args: --workspace --exclude "sui-benchmark" --no-deps
- name: Deploy documentation
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # pin@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./target/doc
force_orphan: true