This repository has been archived by the owner on Jul 16, 2024. It is now read-only.
Add doc for embedding without index #956
Workflow file for this run
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: Build Docs | |
on: | |
workflow_dispatch: | |
pull_request: | |
branches: [ main ] | |
push: | |
branches: | |
- main | |
tags: | |
- "*" | |
jobs: | |
build: | |
name: Build Docs | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python | |
uses: actions/setup-python@v2 | |
with: | |
python-version: 3.9 | |
- name: Install dependencies | |
run: | | |
sudo apt-get install -y libpq-dev pandoc | |
- name: Install python dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install tox==3.25.0 | |
- name: docstyle check | |
run: | | |
tox -e docstyle | |
- name: Build the docs | |
run: | | |
export TAG_REF=${{ github.ref }} | |
tox -e doc | |
- name: Save ref | |
run: echo "${{ github.ref }}" >> build/doc/ref.txt | |
- name: Save docs artifact | |
uses: actions/upload-artifact@v2 | |
with: | |
name: doc | |
path: build/doc/* |