🎨 publish report to GitHub Pages #62

	name: Test documentation building, and publish report to GitHub Pages

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]
	release:
	types: [published]

	jobs:
	test:
	name: Test
	runs-on: ubuntu-latest
	strategy:
	matrix:
	python-version: ["3.11"]
	steps:
	- uses: actions/checkout@v4
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	cache: 'pip' # caching pip dependencies
	cache-dependency-path: '**/pyproject.toml'
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -e .[docs]
	- name: Build references
	run: \|
	cd docs
	sphinx-apidoc --force --implicit-namespaces --module-first -o reference ../src/vuegen
	- name: Build documentation
	run: \|
	cd docs
	sphinx-build -n --keep-going -b html ./ ./_build/
	- name: Rename entry point of report to index.html
	run: \|
	mv docs/quarto_report/quarto_report.html docs/quarto_report/index.html
	- name: Publish html report to github pages
	# Only publish a new static report upon a new release -> can be changed.
	if: startsWith(github.ref, 'refs/tags')
	uses: peaceiris/actions-gh-pages@v4
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: docs/quarto_report/
	# - name: save artifacts
	# uses: actions/upload-artifact@v4
	# with:
	# name: Sphinx_${{ matrix.python-version }}
	# path: docs/_build/

Provide feedback