You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
1.9 KiB
74 lines
1.9 KiB
name: Manual Docs Versioning
|
|
on:
|
|
workflow_dispatch:
|
|
inputs:
|
|
version:
|
|
description: 'Documentation version to create'
|
|
required: true
|
|
commit:
|
|
description: 'Commit used to build the Documentation version'
|
|
required: false
|
|
latest:
|
|
description: 'Latest version'
|
|
type: boolean
|
|
|
|
permissions:
|
|
contents: write
|
|
jobs:
|
|
docs:
|
|
name: Generate Website for new version
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
if: inputs.commit == ''
|
|
|
|
- uses: actions/checkout@v3
|
|
if: inputs.commit != ''
|
|
with:
|
|
ref: ${{ inputs.commit }}
|
|
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: '3.9'
|
|
|
|
- name: Install dependencies
|
|
run: pip install -r docs/requirements.txt
|
|
|
|
- name: Register Envs
|
|
run: pip install -e .
|
|
|
|
- name: Build Envs Docs
|
|
run: python docs/_scripts/gen_env_docs.py
|
|
|
|
- name: Build Envs Display
|
|
run: python docs/_scripts/gen_envs_display.py
|
|
|
|
- name: Build
|
|
run: sphinx-build -b dirhtml -v docs _build
|
|
|
|
- name: Move 404
|
|
run: mv _build/404/index.html _build/404.html
|
|
|
|
- name: Update 404 links
|
|
run: python docs/_scripts/move_404.py _build/404.html
|
|
|
|
- name: Remove .doctrees
|
|
run: rm -r _build/.doctrees
|
|
|
|
- name: Upload to GitHub Pages
|
|
uses: JamesIves/github-pages-deploy-action@v4
|
|
with:
|
|
folder: _build
|
|
target-folder: ${{ inputs.version }}
|
|
clean: false
|
|
|
|
- name: Upload to GitHub Pages
|
|
uses: JamesIves/github-pages-deploy-action@v4
|
|
if: inputs.latest
|
|
with:
|
|
folder: _build
|
|
clean-exclude: |
|
|
*.*.*/
|
|
main
|