Skip to content

Nightly Documentation Build #880

Nightly Documentation Build

Nightly Documentation Build #880

name: Nightly Documentation Build
on:
schedule: # UTC at 0400
- cron: '0 4 * * *'
workflow_dispatch:
env:
DOCUMENTATION_CNAME: 'visualization.fluent.docs.pyansys.com'
MAIN_PYTHON_VERSION: '3.10'
DOC_DEPLOYMENT_IMAGE_TAG: v24.2.0
ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
PYFLUENT_TIMEOUT_FORCE_EXIT: 5
PYFLUENT_LAUNCH_CONTAINER: 1
jobs:
nightly_docs_build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ env.MAIN_PYTHON_VERSION }}
- name: Install OS packages
run: |
sudo apt update
sudo apt install pandoc libegl1
- name: Install pyfluent-visualization
run: make install
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ secrets.GH_USERNAME }}
password: ${{ secrets.REPO_DOWNLOAD_PAT }}
- name: Pull Fluent docker image
run: make docker-pull
env:
FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
- name: Generate the documentation
run: make build-doc
env:
FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
- name: Upload HTML Documentation
uses: actions/upload-artifact@v4
with:
name: HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
path: doc/_build/html
retention-days: 7
- name: Deploy
uses: ansys/actions/doc-deploy-dev@v6
with:
doc-artifact-name: 'HTML-Documentation-tag-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}'
cname: ${{ env.DOCUMENTATION_CNAME }}
token: ${{ secrets.GITHUB_TOKEN }}