Manual Docs Versioning #1
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: Manual Docs Versioning | |
on: | |
workflow_dispatch: | |
inputs: | |
version: | |
description: 'Documentation version to create' | |
required: true | |
commit: | |
description: 'Commit used to build the Documentation version (SHA)' | |
required: false | |
latest: | |
description: 'Latest version' | |
type: boolean | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
name: Generate Website for new version | |
runs-on: ubuntu-latest | |
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' | |
- run: sudo apt-get install xvfb | |
- name: Install dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Install Minari | |
run: pip install .[all] | |
- name: Build Datasets Docs | |
run: xvfb-run --auto-servernum python docs/_scripts/gen_dataset_md.py | |
- name: Build | |
run: sphinx-build -b dirhtml -v docs _build | |
- 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 |