Add `detect_oscillatory_events` method #715

	name: documentation

	on:
	push:
	branches: [ main ]
	pull_request:
	branches: [ main]
	workflow_dispatch:
	branches: [ main]


	permissions:
	contents: write

	jobs:
	docs:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	# this is necessary for setuptools_scm to work properly with github
	# actions, see https://github.com/pypa/setuptools_scm/issues/480 and
	# https://stackoverflow.com/a/68959339
	with:
	fetch-depth: 0
	- uses: actions/setup-python@v5
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install .[doc]
	- name: Sphinx build
	run: \|
	sphinx-build doc _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: _build/
	force_orphan: true

Provide feedback