Skip to content

Documentation Template Refactor #10

Documentation Template Refactor

Documentation Template Refactor #10

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: "feature/doctest_meta_call" # Change this to the specific tag version you want
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@v2
- uses: julia-actions/cache@v2
- name: Use Documentation Template
run: |
./docs/get_docs_utils.sh ${{ env.DOC_TEMPLATE_VERSION }}
- 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; Z = collect(1.5:12.5); dim = 3); recursive=true)
doctest(TrajectoryIndexingUtils)'