This repository has been archived by the owner on Oct 4, 2024. It is now read-only.

Merge pull request #440 from tjni/update-pyyaml #97

	name: Docs CI

	on:
	push:
	branches:
	# Add more branches here to publish docs from other branches
	- master
	- main
	tags:
	- "*"
	pull_request:

	jobs:
	docs:
	if: github.event_name != 'pull_request' \|\| github.event.pull_request.head.repo.full_name != github.repository
	strategy:
	fail-fast: false
	matrix:
	os: ["ubuntu-latest"]
	python: ["3.10"]

	runs-on: ubuntu-latest

	steps:
	- name: Avoid git conflicts when tag and branch pushed at same time
	if: startsWith(github.ref, 'refs/tags')
	run: sleep 60

	- name: Install python version
	uses: actions/setup-python@v2
	with:
	python-version: ${{ matrix.python }}

	- name: Install Packages
	# Can delete this if you don't use graphviz in your docs
	run: sudo apt-get install graphviz

	- name: checkout
	uses: actions/checkout@v2
	with:
	fetch-depth: 0

	- name: install dependencies
	run: \|
	touch requirements_dev.txt
	pip install -r requirements_dev.txt -e .[dev]

	- name: Build docs
	run: tox -e docs

	- name: Move to versioned directory
	# e.g. master or 0.1.2
	run: mv build/html ".github/pages/${GITHUB_REF##*/}"

	- name: Write versions.txt
	run: sphinx_rtd_theme_github_versions .github/pages

	- name: Publish Docs to gh-pages
	if: github.event_name == 'push'
	# We pin to the SHA, not the tag, for security reasons.
	# https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
	uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: .github/pages
	keep_files: true

Provide feedback