build documentation to faiss_embedding
#31
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: website | |
# build the documentation whenever there are new commits on main | |
on: | |
push: | |
branches: | |
- main | |
# 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@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: '3.11' | |
# ADJUST THIS: install all dependencies (including pdoc) | |
- run: pip install pdoc3 | |
- run: pip install -e . | |
- run: pip install faiss-cpu | |
- run: python -m spacy download en_core_web_sm | |
# 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: pdoc -o docs_pdocs/ suql.sql_free_text_support.execute_free_text_sql --html | |
- run: pdoc -o docs_pdocs/ suql.faiss_embedding --html | |
- uses: actions/upload-pages-artifact@v3 | |
with: | |
path: docs_pdocs/ | |
# Deploy the artifact to GitHub pages. | |
# 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@v4 |