Docs

build(deps): update rust crate itertools to 0.14.0 (#115) #63

	name: Docs

	on:
	workflow_dispatch:
	push:
	branches: [master]

	# For more info: https://stackoverflow.com/a/74167257/11663108
	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: docs
	cancel-in-progress: false

	jobs:
	build:
	name: Build
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- name: Install Rust
	uses: dtolnay/rust-toolchain@stable

	- name: Setup Rust cache
	uses: Swatinem/rust-cache@v2

	- name: Clean docs folder
	run: cargo clean --doc

	# TODO: for now document private items, once the documentation and cleanup is done
	# remove it
	- name: Build docs
	run: cargo doc --no-deps --document-private-items

	- name: Remove lock
	run: rm target/doc/.lock

	- name: Add redirect
	run: \|
	echo '<meta http-equiv="refresh" content="0; url=kernel/index.html" />' > target/doc/index.html

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: target/doc

	deploy:
	name: Deploy
	runs-on: ubuntu-latest
	needs: build
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	steps:
	- name: Deploy to github pages
	uses: actions/deploy-pages@v4
	id: deployment

Provide feedback