docs

docs #19

	name: docs

	# build the documentation whenever there are new commits on main
	on: workflow_dispatch

	# security: restrict permissions for CI jobs.
	permissions:
	contents: read

	jobs:
	# Build the documentation and upload the static HTML files as an artifact.
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3
	- uses: actions/setup-python@v4
	with:
	python-version: '3.10'
	- name: Install Poetry
	uses: snok/install-poetry@v1
	with:
	version: 1.3.2

	- run: poetry install --with dev --all-extras
	- run: poetry run pip uninstall -y torch torchvision; poetry run pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
	# ADJUST THIS: build your documentation into docs/.
	# We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
	- run: poetry run pdoc -d google -o docs/ --logo https://d33wubrfki0l68.cloudfront.net/682006698903a55560c796b901fdfe4446c6d27a/a00ee/images/pinecone-logo.svg --search -t pdoc_theme pinecone_text

	- uses: actions/upload-pages-artifact@v1
	with:
	path: docs/

	# This is a separate job so that only actions/deploy-pages has the necessary permissions.
	deploy:
	needs: build
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v1

Provide feedback