[feat]: added docs deploy #5

	name: documentation

	on: [push, pull_request, workflow_dispatch]

	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 sphinx sphinx_rtd_theme myst_parser

	- name: Sphinx build
	run: \|
	python -m pip install -U sphinx
	python -m pip install sphinx-rtd-theme
	python -m pip install sphinx-autoapi

	- name: make the sphinx docs
	run: \|
	make -C docs clean
	# sphinx-apidoc -f -o docs/source . -H Test -e -t docs/source/_templates
	make -C docs html

	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v3
	if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
	with:
	publish_branch: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	directory: ./docs/build/html
	force_orphan: true

Provide feedback