[FIX]: BBI documentation + Add LOCO as importance function #31
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: Documentation | |
on: | |
pull_request: | |
push: | |
branches: main | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
env: | |
# Force to use color | |
FORCE_COLOR: true | |
BROWSER: /usr/bin/firefox | |
DISPLAY: :99.0 | |
permissions: | |
contents: write | |
jobs: | |
build_docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
- name: Install dependencies | |
run: | | |
pip install -r doc_conf/doc-requirements.txt | |
pip install -e . | |
- name: Sphinx build | |
id: build-docs | |
run: | | |
sphinx-build -b html doc_conf doc/_build/html | |
- name: Upload documentation | |
if: steps.build-docs.outcome == 'success' | |
uses: actions/upload-artifact@v4 | |
with: | |
name: DocHTML | |
path: doc/_build/html | |
deploy_on_main: | |
runs-on: ubuntu-latest | |
needs: [build_docs] | |
if: ${{ contains(fromJSON('["push", "workflow_dispatch", "schedule"]'), github.event_name)}} | |
steps: | |
- name: Download artifacts | |
uses: actions/download-artifact@v4 | |
with: | |
name: DocHTML | |
path: doc/_build/html | |
- name: Commit to main | |
run: | | |
git clone --depth 1 https://github.com/${{ github.repository_owner }}/hidimstat.git | |
rm -Rf hidimstat/docs | |
mkdir hidimstat/docs | |
cp -r doc/_build/html/* hidimstat/docs | |
cd hidimstat | |
touch docs/.nojekyll | |
git config --global user.email "[email protected]" | |
git config --global user.name "GitHub actions" | |
git add . | |
git commit -m "Update documentation" -a || true | |
- name: Push changes | |
uses: ad-m/github-push-action@master | |
with: | |
branch: main | |
directory: hidimstat | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |