Skip to content

update CHANGELOG (#504) #218

update CHANGELOG (#504)

update CHANGELOG (#504) #218

Workflow file for this run

name: build-docs
on:
workflow_dispatch:
push:
branches: [ main ]
release:
types: [ published ]
# set GITHUB_TOKEN permissions to allow deployment to GitHub Pages
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
if: github.repository_owner == 'autoatml' && github.ref == 'refs/heads/main'
defaults:
run:
shell: bash -l {0} # enables conda/mamba env activation by reading bash profile
env:
PYTHON_VERSION: "3.10"
steps:
- name: Check out repo
uses: actions/checkout@v4
- name: Set up micromamba
uses: mamba-org/setup-micromamba@main
- name: Clean mamba cache
run: |
micromamba clean -a -y
- name: Create mamba environment
run: |
micromamba create -n autoplex_docs python=$PYTHON_VERSION --yes
- name: Install uv
run: micromamba run -n autoplex_docs pip install uv
- name: Install autoplex and dependencies
run: |
micromamba activate autoplex_docs
uv pip install --upgrade pip
uv pip install --prerelease=allow .[docs,strict,tests]
uv pip install --upgrade monty
uv pip install numpy==1.26.4
- name: Copy tutorials
run: |
mkdir -p docs/user/executable
cp -r tutorials/* docs/user/executable
micromamba run -n autoplex_docs jupyter nbconvert --to markdown docs/user/executable/*.ipynb
- name: Build
run: micromamba run -n autoplex_docs sphinx-build -W docs _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true