From 8f85f865e3fd38a93d6010c212aa5246f461f497 Mon Sep 17 00:00:00 2001 From: Huiyu Xie Date: Mon, 18 Nov 2024 18:54:27 -1000 Subject: [PATCH] Enable documentation build again (#69) * Start * Fix error * Fix README.md * Add tutorials * Add new logo * Change logo * Final logo * Add dependencies * Minor fix on CI * Remove docs build * Minor test * Enable docs build * Minor fix * Only build docs on julia 1.10 Signed-off-by: Qingyu Qu <2283984853@qq.com> --------- Signed-off-by: Qingyu Qu <2283984853@qq.com> Co-authored-by: Qingyu Qu <2283984853@qq.com> --- .github/workflows/Documentation.yml | 30 +++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/workflows/Documentation.yml diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml new file mode 100644 index 0000000..d9fc93a --- /dev/null +++ b/.github/workflows/Documentation.yml @@ -0,0 +1,30 @@ +name: Documentation + +on: + push: + branches: + - main # update to match your development branch (master, main, dev, trunk, ...) + tags: "*" + pull_request: + +jobs: + build: + permissions: + actions: write + contents: write + pull-requests: read + statuses: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v2 + with: + version: "1.10" + - uses: julia-actions/cache@v2 + - name: Install dependencies + run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' + - name: Build and deploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token + DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key + run: julia --project=docs/ --color=yes docs/make.jl