docs

SHA512 symbolic simulation effort that leverages presimplified block … #155

	name: docs

	on:
	push:
	branches:
	- "main"
	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	jobs:
	build:
	name: Documentation
	runs-on: ubuntu-latest

	steps:

	- uses: actions/checkout@v4

	- uses: leanprover/[email protected]
	with:
	use-mathlib-cache: false
	use-github-cache: true

	- name: Generate docs
	run: \|
	./docgen.sh \|\| true # allow documentation generation to fail, as a test.

	# Disable documentation uploading until we are happy with our docs.
	# stolen from mathlib: https://github.com/leanprover-community/mathlib4_docs/blob/1f4ea7657bc377b4298fd400e567471d3a248b2d/.github/workflows/docs.yaml#L79-L86
	# - name: Upload artifact 📁
	# uses: actions/upload-pages-artifact@v1
	# with:
	# path: '.lake/build/doc'
	#
	# - name: Deploy to GitHub Pages 🚀
	# id: deployment
	# uses: actions/deploy-pages@v1

Provide feedback