Docs

Merge pull request #43 from open-atmos/stub_yaml_option #95

	name: Docs
	on:
	push:
	branches:
	- main
	pull_request:
	branches:
	- main
	workflow_dispatch:
	branches:
	- main

	permissions:
	contents: write

	jobs:
	docs:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions/setup-python@v3

	- name: Install dependencies
	run: \|
	pip install -r docs/requirements.txt

	- name: Debugging information
	run: \|
	echo "github.ref:" ${{github.ref}}
	echo "github.event_name:" ${{github.event_name}}
	echo "github.head_ref:" ${{github.head_ref}}
	echo "github.base_ref:" ${{github.base_ref}}
	set -x
	git rev-parse --abbrev-ref HEAD
	git branch
	git branch -a
	git remote -v
	python -V
	pip list --not-required
	pip list

	- name: Setup gh-pages folder
	run: \|
	set -x
	git fetch
	( git branch gh-pages remotes/origin/gh-pages && git clone . --branch=gh-pages _gh-pages/ ) \|\| mkdir _gh-pages
	rm -rf _gh-pages/.git/

	- name: Build documentation
	run: \|
	cd docs
	make html
	ls -l
	ls -l build/html
	cp -r build/html/* ../_gh-pages/

	# Add the .nojekyll file
	- name: nojekyll
	if: ${{ github.event_name == 'push' }}
	run: \|
	touch _gh-pages/.nojekyll

	- name: Debugging information
	run: \|
	ls -la _gh-pages/

	# Deploy
	# https://github.com/peaceiris/actions-gh-pages
	- name: Deploy
	uses: peaceiris/actions-gh-pages@v3
	if: ${{ github.event_name == 'push' }}
	with:
	publish_branch: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: _gh-pages/
	force_orphan: true

Provide feedback