Merge pull request #6 from joshivanhoe/docs/fix-docstring-conventions #2

	name: Generate API documentation
	on:
	push:
	branches: [ "main" ]

	jobs:
	deploy:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@main
	- name: Set up Python 3
	uses: actions/setup-python@v5
	with:
	python-version: 3.11

	- name: Install requirements for documentation generation
	run: \|
	python -m pip install --upgrade pip setuptools wheel
	python -m pip install docutils pydoctor

	- name: Run pydoctor
	run: \|

	# Run pydoctor build
	pydoctor \
	--project-name=halfspace \
	--project-url=https://github.com/$GITHUB_REPOSITORY \
	--html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \
	--make-html \
	--html-output=./apidocs \
	--project-base-dir="$(pwd)" \
	--docformat=google \
	--intersphinx=https://docs.python.org/3/objects.inv \
	./src/halfspace

	- name: Push API documentation to Github Pages
	uses: peaceiris/actions-gh-pages@v3
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./apidocs
	commit_message: "Generate API documentation"

Provide feedback