This repository has been archived by the owner on Apr 21, 2024. It is now read-only.

Refactor the library to work with classes #23

	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 Pandoc
	run: \|
	sudo apt-get update
	sudo apt-get install -y pandoc
	- name: Install dependencies
	run: \|
	pip install ".[docs]"
	python -m ipykernel install --user --name python3
	- name: Sphinx build
	run: \|
	sphinx-build docs/source docs/build
	- 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 }}
	publish_dir: ./docs/build/
	force_orphan: true

Provide feedback