readme change #258

	name: test-lint-docs

	on:
	push:
	branches:
	- main
	pull_request:
	branches:
	- main

	jobs:
	lint-and-test:
	runs-on: ubuntu-latest

	env:
	OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

	steps:
	- name: Checkout repository
	uses: actions/checkout@v3

	- name: List root directory contents for debugging
	run: ls -la

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: '3.9'

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install flake8
	pip install -r dev_requirements.txt

	- name: Lint with flake8
	run: \|
	flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
	flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

	- name: Run tests
	run: \|
	pytest plurals/unit_test.py

	build-and-deploy-docs:
	runs-on: ubuntu-latest
	needs: lint-and-test

	steps:
	- name: Checkout repository
	uses: actions/checkout@v3

	- name: Set up Python
	uses: actions/setup-python@v4
	with:
	python-version: '3.9'

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install -r dev_requirements.txt
	pip install sphinx sphinx_rtd_theme

	- name: Build Sphinx documentation
	run: \|
	cd docs
	make html

	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v3
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: docs/_build/html

Provide feedback