From cdf02a41b538966d659d01004a7f963b61f98826 Mon Sep 17 00:00:00 2001 From: Jack Champagne Date: Thu, 12 Feb 2026 19:59:12 -0500 Subject: [PATCH] move archived packages to Archive section, add build artifacts Move PiccoloQuantumObjects, QuantumCollocation, and PiccoloPlots to the Archive dropdown in the multidocs config. Promote DirectTrajOpt to a top-level nav entry. Add documentation artifact uploads to the Aggregate and Rebuild workflows for review and debugging. Co-Authored-By: Claude Opus 4.6 --- .github/workflows/rebuild_docs.yml | 6 ++++ .github/workflows/test.yml | 6 ++++ docs/make.jl | 52 +++++++++++++----------------- 3 files changed, 35 insertions(+), 29 deletions(-) diff --git a/.github/workflows/rebuild_docs.yml b/.github/workflows/rebuild_docs.yml index 4bc8cd91..5bcfe0ae 100644 --- a/.github/workflows/rebuild_docs.yml +++ b/.github/workflows/rebuild_docs.yml @@ -19,6 +19,12 @@ jobs: run: julia --project=docs -e 'using Pkg; Pkg.instantiate()' - name: Build documentation run: julia --project=docs docs/make.jl + - name: Upload documentation artifacts + uses: actions/upload-artifact@v4 + with: + name: multidocs-build + path: docs/out/ + retention-days: 7 - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v4 with: diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index da0a4aab..67857406 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -28,3 +28,9 @@ jobs: run: julia --project=docs -e 'using Pkg; Pkg.instantiate()' - name: Build documentation run: julia --project=docs docs/make.jl + - name: Upload documentation artifacts + uses: actions/upload-artifact@v4 + with: + name: multidocs-build + path: docs/out/ + retention-days: 7 diff --git a/docs/make.jl b/docs/make.jl index 71d5ecb2..b49cbe95 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -36,27 +36,10 @@ docs = [ giturl = "https://github.com/harmoniqs/Piccolo.jl.git", ), MultiDocumenter.MultiDocRef( - upstream = joinpath(clonedir, "PiccoloQuantumObjects"), - path = "PiccoloQuantumObjects", - name = "Quantum Objects", - giturl = "https://github.com/harmoniqs/PiccoloQuantumObjects.jl.git", - ), - MultiDocumenter.DropdownNav( - "Optimal Controls", - [ - MultiDocumenter.MultiDocRef( - upstream = joinpath(clonedir, "QuantumCollocation"), - path = "QuantumCollocation", - name = "QuantumCollocation.jl", - giturl = "https://github.com/harmoniqs/QuantumCollocation.jl.git", - ), - MultiDocumenter.MultiDocRef( - upstream = joinpath(clonedir, "DirectTrajOpt"), - path = "DirectTrajOpt", - name = "DirectTrajOpt.jl", - giturl = "https://github.com/harmoniqs/DirectTrajOpt.jl.git", - ), - ], + upstream = joinpath(clonedir, "DirectTrajOpt"), + path = "DirectTrajOpt", + name = "DirectTrajOpt.jl", + giturl = "https://github.com/harmoniqs/DirectTrajOpt.jl.git", ), MultiDocumenter.DropdownNav( "Trajectories", @@ -75,23 +58,34 @@ docs = [ ), ], ), - MultiDocumenter.MultiDocRef( - upstream = joinpath(clonedir, "PiccoloPlots"), - path = "PiccoloPlots", - name = "Plots", - giturl = "https://github.com/harmoniqs/PiccoloPlots.jl.git", - ), - MultiDocumenter.DropdownNav( "Archive", [ + MultiDocumenter.MultiDocRef( + upstream = joinpath(clonedir, "PiccoloQuantumObjects"), + path = "PiccoloQuantumObjects", + name = "PiccoloQuantumObjects.jl", + giturl = "https://github.com/harmoniqs/PiccoloQuantumObjects.jl.git", + ), + MultiDocumenter.MultiDocRef( + upstream = joinpath(clonedir, "QuantumCollocation"), + path = "QuantumCollocation", + name = "QuantumCollocation.jl", + giturl = "https://github.com/harmoniqs/QuantumCollocation.jl.git", + ), + MultiDocumenter.MultiDocRef( + upstream = joinpath(clonedir, "PiccoloPlots"), + path = "PiccoloPlots", + name = "PiccoloPlots.jl", + giturl = "https://github.com/harmoniqs/PiccoloPlots.jl.git", + ), MultiDocumenter.MultiDocRef( upstream = joinpath(clonedir, "QuantumCollocationCore"), path = "QuantumCollocationCore", name = "QuantumCollocationCore.jl", giturl = "https://github.com/harmoniqs/QuantumCollocationCore.jl.git", ), - ] + ], ), ]