Skip to content

Refactor code structure for improved readability and maintainability #9

Refactor code structure for improved readability and maintainability

Refactor code structure for improved readability and maintainability #9

Workflow file for this run

name: Build and Deploy Docs
on:
push:
branches:
- main
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
pip install sphinx==7.1.2 sphinx-rtd-theme==1.3.0rc1 furo
pip install torch torchvision torchaudio huggingface_hub safetensors==0.4.5 mup==1.0.0
# add more dependencies if needed (e.g., numpydoc, myst_parser)
- name: Build HTML
run: |
sphinx-build -b html docs docs/_build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_build/html
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4