Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
fengzch-das
nunchaku
Commits
ae2a1d72
Unverified
Commit
ae2a1d72
authored
Jul 22, 2025
by
Muyang Li
Committed by
GitHub
Jul 22, 2025
Browse files
chore: add build docs workflow (#555)
parent
9ebbfac8
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
61 additions
and
0 deletions
+61
-0
.github/workflows/build-docs.yaml
.github/workflows/build-docs.yaml
+61
-0
No files found.
.github/workflows/build-docs.yaml
0 → 100644
View file @
ae2a1d72
name
:
Build Docs
on
:
schedule
:
-
cron
:
'
0
7
*
*
*'
# UTC time
workflow_dispatch
:
jobs
:
tag
:
name
:
Check if main branch is a dev version
runs-on
:
[
self-hosted
,
blackwell
]
if
:
github.repository == 'nunchaku-tech/nunchaku'
steps
:
-
name
:
Checkout main branch
uses
:
actions/checkout@v4
with
:
fetch-depth
:
0
ref
:
main
submodules
:
true
-
name
:
Set up Python
run
:
|
which python
echo "Setting up Python with Conda"
conda create -n nunchaku-docs python=3.12 -y
-
name
:
Install dependencies
run
:
|
source $(conda info --base)/etc/profile.d/conda.sh
conda activate nunchaku-docs || { echo "Failed to activate conda env"; exit 1; }
which python
conda install -c conda-forge gxx=11 gcc=11
echo "Installing dependencies"
pip install torch==2.7 torchvision==0.22 torchaudio==2.7 --index-url https://download.pytorch.org/whl/cu128
pip install git+https://github.com/huggingface/diffusers
pip install ninja wheel transformers==4.51 accelerate==1.7 sentencepiece==0.2 protobuf==6.31 huggingface_hub==0.31
pip install sphinx sphinx-tabs myst-parser sphinx-copybutton breathe sphinxcontrib-mermaid nbsphinx jupyter ipykernel graphviz sphinxext-rediraffe
pip install furo sphinxawesome-theme sphinx-book-theme sphinx-rtd-theme
-
name
:
Build
run
:
|
source $(conda info --base)/etc/profile.d/conda.sh
conda activate nunchaku-docs || { echo "Failed to activate conda env"; exit 1; }
which python
NUNCHAKU_INSTALL_MODE=ALL python setup.py develop
pip install -r tests/requirements.txt
-
name
:
Build docs
run
:
|
source $(conda info --base)/etc/profile.d/conda.sh
conda activate nunchaku-docs || { echo "Failed to activate conda env"; exit 1; }
which python
cd docs
make html
-
name
:
Deploy docs
run
:
|
source $(conda info --base)/etc/profile.d/conda.sh
conda activate nunchaku-docs || { echo "Failed to activate conda env"; exit 1; }
which python
rsync -avz --delete docs/build/html/ ${{ secrets.DO_USER }}@${{ secrets.DO_HOST }}:${{ secrets.DO_DOCS_ROOT }}/nunchaku-nightly
env
:
RSYNC_RSH
:
"
ssh
-o
StrictHostKeyChecking=no
-i
${{
secrets.DO_SSH_KEY
}}"
-
name
:
Clean up
if
:
always() && github.repository == 'nunchaku-tech/nunchaku'
run
:
|
cd ..
rm -r nunchaku
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment