Update Pollen.jl documentation (#262)

* Update Pollen.jl documentation
* Fix tests and add compat

Author: lorenzoh

.github/workflows/pollen.build.yml

@@ -0,0 +1,58 @@
+on:
+  workflow_call:
+    inputs:
+      tag:
+        description: 'The version tag to associate with this documentation build, e.g. "dev", "stable", "pr-201"'
+        required: true
+        default: "dev"
+        type: string
+      docdir:
+        description: "Path of the subdirectory where Pollen's Project.toml, make.jl, and project.jl are stored."
+        required: false
+        default: "docs"
+        type: string
+      databranch:
+        description: "Branch where the generated documentation is stored"
+        required: false
+        default: "pollen"
+        type: string
+      juliaversion:
+        description: "Julia version to use when building the documentation"
+        required: false
+        default: "1.8"
+        type: string
+
+jobs:
+  pollen:
+    name: "Pollen - Build documentation data"
+    runs-on: ubuntu-latest
+    steps:
+      # Check out the package directory at the branch that triggered
+      # the workflow
+      - uses: actions/checkout@v2
+      # Check out Pollen.jl's data branch, where the generated documentation
+      # data will be stored.
+      - uses: actions/checkout@v2
+        with:
+          ref: ${{inputs.databranch}}
+          path: pollen
+      # Install Julia
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{inputs.juliaversion}}
+      # Install the package to-be-documented and its dependencies. Also adds
+      - name: "Install package and docs dependencies"
+        run: |
+          julia --color=yes --project=./${{inputs.docdir}} -e 'using Pkg; Pkg.develop([Pkg.PackageSpec(path="."), Pkg.PackageSpec(path="./FastVision"), Pkg.PackageSpec(path="./FastMakie"), Pkg.PackageSpec(path="./FastTabular"), Pkg.PackageSpec(url="https://github.com/lorenzoh/Pollen.jl")]); Pkg.instantiate();'
+      # Build the documentation data and annotate it with the package tag
+      - name: Build
+        run: |
+          julia --color=yes --project=./${{inputs.docdir}} ./${{inputs.docdir}}/make.jl ./pollen/ ${{inputs.tag}}
+      - name: Deploy
+        run: |
+          cd pollen
+          git config user.name github-actions
+          git config user.email [email protected]
+          git add .
+          git commit -m "Build documentation data (Pollen.jl)"
+          git push

.github/workflows/pollen.render.yml

@@ -13,15 +13,15 @@ jobs:
     name: "Pollen - Prerender static frontend and deploy"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           ref: pollen
           path: data
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           ref: "gh-pages"
           path: pages
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           repository: lorenzoh/pollenjl-frontend
           path: frontend
@@ -31,7 +31,7 @@ jobs:
           ls
           rm -rf data/.git
           cp -r data/ frontend/static/
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
       - name: Install dependencies
         run: |
           cd frontend

.github/workflows/pollen.trigger.dev.yml

@@ -0,0 +1,15 @@
+name: Pollen.jl build - dev
+
+on:
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  pollen:
+    name: "Pollen - Build documentation on push to main"
+    uses: "./.github/workflows/pollen.build.yml"
+    with:
+      tag: dev
+    secrets: inherit

.github/workflows/pollen.trigger.pr.yml

@@ -0,0 +1,24 @@
+name: Pollen.jl build - PR preview
+
+on:
+  - pull_request
+
+jobs:
+  pollen:
+    name: "Pollen - Build documentation on push to main"
+    uses: "./.github/workflows/pollen.build.yml"
+    with:
+      tag: pr-${{ github.event.number }}
+    secrets: inherit
+  commentonpr:
+    runs-on: ubuntu-latest
+    needs: pollen
+    name: "Comment on pull request"
+    steps:
+      - name: Comment PR
+        uses: unsplash/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          msg: "A documentation preview has been successfully built, view it here: [Documentation preview PR-${{github.event.number}}](https://${{github.event.repository.owner.login}}.github.io/${{github.event.repository.name}}/pr-${{github.event.pull_request.number}})"
+          delete_prev_regex_msg: "ocumentation preview PR"

.github/workflows/pollen.trigger.release.yml

@@ -0,0 +1,19 @@
+name: Pollen.jl build - Release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  pollen:
+    name: "Pollen - Build documentation on push to main"
+    uses: "./.github/workflows/pollen.build.yml"
+    with:
+      tag: ${{github.event.release.name}}
+    secrets: inherit
+  pollenstable:
+    name: "Pollen - Build documentation on push to main"
+    uses: "./.github/workflows/pollen.build.yml"
+    with:
+      tag: stable
+    secrets: inherit

.github/workflows/pollenbuild.yml

@@ -4,4 +4,5 @@ docs/Manifest.toml
 development/**
 Manifest.toml
 **/*.jld2
-*.so
+*.so
+SysimagePreferences.toml

.github/workflows/pollenpr.yml

@@ -92,14 +92,3 @@ Base.length(dataset::TableDataset{<:CSV.File}) = length(dataset.table)
         rm("test.csv")
     end
 end
-
-@testset "TimeSeriesDataset" begin
-    @testset "TimeSeriesDataset from TS" begin
-        folderpath = datasetpath("atrial")
-        filepath = joinpath(folderpath, "AtrialFibrillation_TRAIN.ts")
-        tsd = TimeSeriesDataset(filepath)
-        @test tsd isa TimeSeriesDataset{}
-        @test size(getindex(tsd, 10)) == (2, 640)
-        @test length(tsd) == 15
-    end
-end