Skip to content

Documentation Template Refactor #3

Documentation Template Refactor

Documentation Template Refactor #3

Workflow file for this run

name: Documentation
on:
pull_request:
push:
branches:
- main
tags: ['*']
concurrency:
# Skip intermediate builds: always.
# Cancel intermediate builds: only if it is a pull request build.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
jobs:
docs:
name: Documentation
runs-on: ubuntu-latest
permissions:
contents: write
statuses: write
env:
DOC_TEMPLATE_VERSION: "v0.1.1" # Change this to the specific tag version you want
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
- name: Checkout doc_template repository
uses: actions/checkout@v4
with:
repository: harmoniqs/doc_template
ref: ${{ env.DOC_TEMPLATE_VERSION }}
path: doc_template_temp
fetch-depth: 1
- name: Copy utils.jl from doc_template
run: |
cp ./doc_template_temp/utils.jl ./docs/utils.jl
rm -rf ./doc_template_temp
- uses: julia-actions/cache@v2
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-docdeploy@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Upload documentation artifacts
uses: actions/upload-artifact@v4
with:
name: documentation-build
path: docs/build/
retention-days: 1
- run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using TrajectoryIndexingUtils
DocMeta.setdocmeta!(TrajectoryIndexingUtils, :DocTestSetup, :(using TrajectoryIndexingUtils); recursive=true)
doctest(TrajectoryIndexingUtils)'