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

Docs

Merge pull request #3 from DSD-DBS/chore-update-copyright #19

	# SPDX-FileCopyrightText: Copyright DB InfraGO AG and the pyease contributors
	# SPDX-License-Identifier: CC0-1.0

	name: Docs

	on:
	push:
	branches: ["master"]

	jobs:
	sphinx:
	runs-on: ubuntu-latest
	permissions:
	contents: write
	steps:
	- uses: actions/checkout@v2
	with:
	fetch-depth: 0
	- uses: actions/setup-python@v2
	with:
	python-version: "3.10"
	- name: Upgrade pip
	run: \|
	python -m pip install -U pip
	- name: Install dependencies
	run: \|
	python -m pip install '.[docs]'
	- name: Auto-generate APIDOC sources
	run: \|-
	sphinx-apidoc --output-dir docs/source/code --force .
	- name: Create docs
	run: \|
	make -C docs html
	- name: Deploy
	uses: peaceiris/actions-gh-pages@v3
	with:
	force_orphan: true
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./docs/build/html

Provide feedback