Docs

Updating Docs as stadmill has pushed changes to main #28

	name: Docs
	run-name: "Updating Docs as ${{ github.actor }} has pushed changes to main"
	on:
	push:
	branches:
	- main

	jobs:
	docs:
	runs-on: ubuntu-latest
	steps:
	- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
	- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
	- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."

	- name: Check out repository code
	uses: actions/checkout@v3
	- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
	- run: echo "🖥️ The workflow is now ready to test your code on the runner."

	- name: Install Python 3.10
	uses: actions/setup-python@v4
	with:
	python-version: '3.10'

	- name: Install Poetry
	uses: Gr1N/setup-poetry@v8
	with:
	poetry-version: '1.8.3'

	- name: Install dependencies
	run: poetry install

	- name: Build MkDocs documentation
	run: \|
	poetry run mkdocs build

	- name: Publish to gh-pages
	uses: peaceiris/actions-gh-pages@v3
	if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
	with:
	publish_branch: gh-pages # default: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: site
	force_orphan: true

	- run: echo "Status of job = ${{ job.status }}."

Provide feedback