github actions for docs deploy + minor changes in readmes #1

	name: Deploy Documentation to GitHub Pages

	on:
	push:
	branches:
	- dev # Change this to your default branch if it's not 'main'

	jobs:
	build:
	runs-on: ubuntu-latest

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

	- name: Set up Python
	uses: actions/setup-python@v2
	with:
	python-version: '3.x' # Specify the Python version you need

	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install pipenv
	pipenv install --dev

	- name: Build documentation
	run: \|
	pipenv run pandoc -s readme.md -o docs/readme.rst
	pipenv run sphinx-build -M html docs/ docs/_build

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

Provide feedback