Make sure to include the sdist in the releases #1748

	name: Documentation

	on:
	push:
	branches: [main]
	tags: ["*"]
	pull_request:
	# Check all PR

	concurrency:
	group: docs-${{ github.ref }}
	cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}

	jobs:
	build-and-publish:
	runs-on: ubuntu-22.04
	permissions:
	contents: write
	steps:
	- name: free disk space
	run: sudo rm -rf /usr/share/dotnet /usr/local/lib/android \|\| true

	- uses: actions/checkout@v4

	- name: setup rust
	uses: dtolnay/rust-toolchain@master
	with:
	toolchain: stable

	- name: setup Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"

	- name: install dependencies
	run: \|
	python -m pip install tox
	sudo apt install doxygen

	- name: build documentation
	run: tox -e docs
	env:
	# Use the CPU only version of torch when building/running the code
	PIP_EXTRA_INDEX_URL: https://download.pytorch.org/whl/cpu

	- name: store documentation as github artifact to be downloaded by users
	uses: actions/upload-artifact@v4
	with:
	name: docs
	path: docs/build/html/*
	overwrite: true # only keep the latest version of the documentation

	- name: put documentation in the website
	run: \|
	git clone https://github.com/$GITHUB_REPOSITORY --branch gh-pages gh-pages
	rm -rf gh-pages/.git
	cd gh-pages

	REF_KIND=$(echo $GITHUB_REF \| cut -d / -f2)
	if [[ "$REF_KIND" == "tags" ]]; then
	TAG=${GITHUB_REF#refs/tags/}
	mv ../docs/build/html $TAG
	else
	rm -rf latest
	mv ../docs/build/html latest
	fi

	- name: deploy to gh-pages
	if: github.event_name == 'push'
	uses: peaceiris/actions-gh-pages@v4
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./gh-pages/
	force_orphan: true

Provide feedback