Tables api

.github/workflows/CI.yml

@@ -7,6 +7,8 @@ on:
     branches:
       - main
     tags: "*"
+env:
+  JULIA_PKG_USE_CLI_GIT: true
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -15,40 +17,20 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - "1.6" # Replace this with the minimum Julia version that your package supports. E.g. if your package requires Julia 1.5 or higher, change this to '1.5'.
-          - "1" # Leave this line unchanged. '1' will automatically expand to the latest stable 1.x release of Julia.
-          - "nightly"
+          - "1.9"
+          - "1.10"
         os:
           - ubuntu-latest
         arch:
           - x64
-        include:
-          - os: windows-latest
-            version: "1"
-            arch: x64
-          - os: macOS-latest
-            version: "1"
-            arch: x64
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v1
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: actions/cache@v2
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v1
       - uses: julia-actions/julia-buildpkg@v1
+        with:
+          git_cli: true # = JULIA_PKG_USE_CLI_GIT. Options: true | false (default)
       - uses: julia-actions/julia-runtest@v1
-      - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v3
-        env:
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
-            DOCUMENTER_KEY: ${{ secrets.CODECOV_TOKEN }} # If authenticating with SSH deploy key

.github/workflows/Docs.yml

@@ -1,24 +1,36 @@
 name: Docs
 on:
-  pull_request:
-    branches:
-      - main
   push:
     branches:
       - main
-    tags: '*'
+    tags: "*"
+  pull_request:
+
+env:
+  JULIA_PKG_USE_CLI_GIT: true
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+  statuses: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@latest
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: "1.10"
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@v1
         with:
-          version: '1.8'
-      - name: Install dependencies
-        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
-      - name: Build and deploy
+          git_cli: true # = JULIA_PKG_USE_CLI_GIT. Options: true | false (default)
+      - name: Instantiate NPM
+        run: cd docs/; npm i; cd ..
+      - uses: julia-actions/julia-docdeploy@v1
         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/ docs/make.jl
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.gitignore

@@ -23,4 +23,5 @@ docs/site/
 # environment.
 Manifest.toml
 
-/data
+data/
+.vscode/

Project.toml

@@ -1,26 +1,22 @@
 name = "EvoLinear"
 uuid = "ab853011-1780-437f-b4b5-5de6f4777246"
 authors = ["jeremie <jeremie.desgagne.bouchard@gmail.com> and contributors"]
-version = "0.4.3"
+version = "0.5.0"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
-Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LoopVectorization = "bdcacae8-1622-11e9-2a5c-532679323890"
 MLJModelInterface = "e80e1ace-859a-464e-9ed9-23947d8ae3ea"
-Optimisers = "3bd65402-5787-11e9-1adc-39752487f4e2"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
-SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
 
 [compat]
 Distributions = "0.25"
-Flux = "0.13, 0.14"
 LoopVectorization = "0.12"
 MLJModelInterface = "1.0"
-Optimisers = "0.2, 0.3"
 Statistics = "1"
 StatsBase = "0.33, 0.34"
 julia = "1.6"

docs/Project.toml

@@ -1,2 +1,3 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"

docs/make.jl

@@ -1,27 +1,28 @@
 using Documenter
+using DocumenterVitePress
 using EvoLinear
 
-makedocs(
+makedocs(;
     sitename="EvoLinear.jl",
     authors="Jeremie Desgagne-Bouchard",
     modules=[EvoLinear],
+    format=DocumenterVitepress.MarkdownVitepress(
+        repo="github.com/jeremiedb/EvoLinear.jl",
+        devbranch="main",
+        devurl="dev"
+    ),
+    warnonly=true,
+    checkdocs=:all,
     pages=[
         "Home" => "index.md",
         "API" => "api.md",
-        "Internals" => "internals.md",
-    ],
-    format=Documenter.HTML(
-        sidebar_sitename=true,
-        edit_link="main",
-        assets=["assets/style.css"]
-    )
+    ]
 )
 
-# Documenter can also automatically deploy documentation to gh-pages.
-# See "Hosting Documentation" and deploydocs() in the Documenter manual
-# for more information.
 deploydocs(
-    repo="github.com/jeremiedb/EvoLinear.jl.git",
-    target="build",
-    devbranch="main"
+    repo="github.com/jeremiedb/EvoLinear.jl",
+    target="build", # this is where Vitepress stores its output
+    branch="gh-pages",
+    devbranch="main",
+    push_preview=true
 )

docs/package.json

@@ -0,0 +1,15 @@
+{
+  "scripts": {
+    "docs:dev": "vitepress dev build/.documenter",
+    "docs:build": "vitepress build build/.documenter",
+    "docs:preview": "vitepress preview build/.documenter"
+  },
+  "dependencies": {
+    "@shikijs/transformers": "^1.1.7",
+    "markdown-it": "^14.1.0",
+    "markdown-it-footnote": "^4.0.0",
+    "markdown-it-mathjax3": "^4.3.2",
+    "vitepress": "^1.1.4",
+    "vitepress-plugin-tabs": "^0.5.0"
+  }
+}

docs/src/.vitepress/config.mts

@@ -0,0 +1,48 @@
+import { defineConfig } from 'vitepress'
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
+import mathjax3 from "markdown-it-mathjax3";
+import footnote from "markdown-it-footnote";
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  base: 'REPLACE_ME_DOCUMENTER_VITEPRESS',// TODO: replace this in makedocs!
+  title: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+  description: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+  lastUpdated: true,
+  cleanUrls: true,
+  outDir: 'REPLACE_ME_DOCUMENTER_VITEPRESS', // This is required for MarkdownVitepress to work correctly...
+  head: [['link', { rel: 'icon', href: 'REPLACE_ME_DOCUMENTER_VITEPRESS_FAVICON' }]],
+  ignoreDeadLinks: true,
+
+  markdown: {
+    math: true,
+    config(md) {
+      md.use(tabsMarkdownPlugin),
+      md.use(mathjax3),
+      md.use(footnote)
+    },
+    theme: {
+      light: "github-light",
+      dark: "github-dark"}
+  },
+  themeConfig: {
+    outline: 'deep',
+    logo: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    search: {
+      provider: 'local',
+      options: {
+        detailedView: true
+      }
+    },
+    nav: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    sidebar: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    editLink: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
+    socialLinks: [
+      { icon: 'github', link: 'REPLACE_ME_DOCUMENTER_VITEPRESS' }
+    ],
+    footer: {
+      message: 'Made with <a href="https://luxdl.github.io/DocumenterVitepress.jl/dev/" target="_blank"><strong>DocumenterVitepress.jl</strong></a><br>',
+      copyright: `© Copyright ${new Date().getUTCFullYear()}.`
+    }
+  }
+})

docs/src/.vitepress/theme/index.ts

@@ -0,0 +1,19 @@
+// .vitepress/theme/index.ts
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+
+import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout() {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    enhanceAppWithTabs(app)
+  }
+} satisfies Theme