Docs

Update the gitignore and readme to aid contributing (#70) #21

	name: Docs

	# build the documentation whenever there are new commits on master
	on:
	push:
	branches:
	- master
	workflow_dispatch:

	# security: restrict permissions for CI jobs.
	permissions:
	contents: read

	jobs:
	# Build the documentation and upload the static HTML files as an artifact.
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions/setup-python@v4
	with:
	python-version: "3.11"

	- run: pip install pdoc
	- run: pdoc -o docs/ -d google stockfish/models.py

	- uses: actions/upload-pages-artifact@v1
	with:
	path: docs/

	# Deploy the artifact to GitHub pages.
	# This is a separate job so that only actions/deploy-pages has the necessary permissions.
	deploy:
	needs: build
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v2

Provide feedback