docs

[Fix] documentation deploy CI/CD job (#1781) #376

	name: docs
	on:
	push:
	branches: main

	jobs:
	docs-deploy:
	runs-on: ${{ matrix.os }}
	strategy:
	matrix:
	os: [ubuntu-latest]
	python: ["3.10"]
	steps:
	- uses: actions/checkout@v4
	with:
	persist-credentials: false
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python }}
	architecture: x64
	- name: Cache python modules
	uses: actions/cache@v4
	with:
	path: ~/.cache/pip
	key: ${{ runner.os }}-pkg-deps-${{ matrix.python }}-${{ hashFiles('pyproject.toml') }}-docs
	- name: Install dependencies
	# Earlier documentation (before v10) requires TensorFlow - later it's built from the PyTorch code - so we need to install both (dev)
	# Additional the dev specifier includes all [docs] dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[dev]

	- name: Build documentation
	run: cd docs && bash build.sh

	- name: Documentation sanity check
	run: test -e docs/build/index.html \|\| exit

	- name: Install SSH Client 🔑
	uses: webfactory/[email protected]
	with:
	ssh-private-key: ${{ secrets.SSH_DEPLOY_KEY }}

	- name: Deploy to Github Pages
	uses: JamesIves/[email protected]
	with:
	BRANCH: gh-pages
	FOLDER: 'docs/build'
	COMMIT_MESSAGE: '[skip ci] Documentation updates'
	CLEAN: true
	SSH: true

Provide feedback