Repository navigation

Merge pull request #3918 from autonomys/proof-of-space-backport #3936

	name: rustdoc

	on:
	push:
	branches:
	- main
	pull_request:
	workflow_dispatch:
	merge_group:

	concurrency:
	group: rustdoc-${{ github.workflow }}-${{ github.ref }}
	cancel-in-progress: true

	env:
	CARGO_INCREMENTAL: 0
	CARGO_NET_RETRY: 10
	CARGO_TERM_COLOR: always
	RUSTUP_MAX_RETRIES: 10
	RUST_BACKTRACE: full

	jobs:
	rustdoc:
	runs-on: ubuntu-22.04

	steps:
	- name: Checkout repository
	uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

	- name: Install Protoc
	uses: arduino/setup-protoc@c65c819552d16ad3c9b72d9dfd5ba5237b9c906b # v3.0.0
	with:
	repo-token: ${{ secrets.GITHUB_TOKEN }}

	- name: Configure cache
	uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
	with:
	path: \|
	~/.cargo/registry
	~/.cargo/git
	key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.toml') }}
	restore-keys: \|
	${{ runner.os }}-cargo-

	# Build the rust crate docs (GPU plotting is built unconditionally)
	- name: Build Documentation
	run: cargo -Zgitoxide -Zgit doc --locked --all --no-deps --lib
	env:
	RUSTDOCFLAGS: "-D rustdoc::broken-intra-doc-links -D rustdoc::private_intra_doc_links -Z unstable-options --enable-index-page"

	- name: Deploy Docs
	uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
	with:
	branch: gh-pages
	single-commit: true
	folder: target/doc
	if: ${{ github.event_name == 'push' }}