Merge pull request #252 from EssamWisam/instate-docs

🚀 Instate documentation for MLJFlux

.github/workflows/documenter.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - dev
+      - instate-docs
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      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@v1
+      - 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/ docs/make.jl

README.md

@@ -50,10 +50,6 @@ and this will require familiarity with the [Flux
 API](https://fluxml.ai/Flux.jl/stable/) for defining a neural network
 chain.
 
-In the future MLJFlux may provide a larger assortment of canned
-builders. Pull requests introducing new ones are most welcome.
-
-
 ### Installation
 
 ```julia

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+site/