Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 40 additions & 7 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,41 @@
name: Documentation

on:
push:
tags:
- v*
# Allows to run the workflow manually
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

env:
CUSTOM_DOMAIN: python-sdk.meilisearch.com

jobs:
docs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
lfs: true
- name: Setup Github Pages
uses: actions/configure-pages@v3
- name: Install Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
python-version: "3.10"
- name: Install pipenv
run: |
pip install pipx
Expand All @@ -29,9 +49,22 @@ jobs:
run: |
pipenv run sphinx-apidoc -f -o docs meilisearch/
pipenv run sphinx-build docs ./docs/_build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# CNAME file is required for GitHub pages custom domain
- name: Create CNAME file
run: |
echo "$CUSTOM_DOMAIN" > ./docs/_build/html/CNAME
echo "Created CNAME in ./docs/_build/html/: $CUSTOM_DOMAIN"
- name: Upload artifacts
uses: actions/upload-pages-artifact@v2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
force_orphan: true
path: "./docs/_build/html"
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
1 change: 0 additions & 1 deletion CNAME

This file was deleted.