Merge pull request #8 from CosmologicalEmulators/develop

Develop

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'develop'
+    paths-ignore:
+      - 'LICENSE.md'
+      - 'README.md'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@latest
+        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
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

.github/workflows/test.yml

@@ -21,7 +21,8 @@ jobs:
         version:
           - '1.7'
           - '1.8'
-          - '^1.9.0-0'
+          - '1.9'
+          - '~1.10.0-0'
         os:
           - ubuntu-latest
         arch:
@@ -42,7 +43,6 @@ jobs:
             ${{ runner.os }}-test-${{ env.cache-name }}-
             ${{ runner.os }}-test-
             ${{ runner.os }}-
-      - run: julia --project=@. -e 'using Pkg; Pkg.add(url="https://github.com/CosmologicalEmulators/AbstractEmulator.jl")'
       - uses: julia-actions/julia-runtest@v1
       - uses: julia-actions/julia-processcoverage@v1
       - uses: codecov/codecov-action@v1

README.md

@@ -1,8 +1,11 @@
 # Capse.jl
 
+| **Documentation**                                                               | **Build Status**                                                                                |
+|:-------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------:|
+| [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://cosmologicalemulators.github.io/Capse.jl/dev) [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://cosmologicalemulators.github.io/Capse.jl/stable) | [![Build status (Github Actions)](https://github.com/CosmologicalEmulators/Capse.jl/workflows/CI/badge.svg)](https://github.com/CosmologicalEmulators/Capse.jl/actions) [![codecov](https://codecov.io/gh/CosmologicalEmulators/Capse.jl/branch/main/graph/badge.svg?token=0PYHCWVL67)](https://codecov.io/gh/CosmologicalEmulators/Capse.jl)
+
+
 [![arXiv](https://img.shields.io/badge/arXiv-2307.14339-b31b1b.svg)](https://arxiv.org/abs/2307.14339)
-[![Build status (Github Actions)](https://github.com/CosmologicalEmulators/Capse.jl/workflows/CI/badge.svg)](https://github.com/CosmologicalEmulators/Capse.jl/actions)
-[![codecov](https://codecov.io/gh/CosmologicalEmulators/Capse.jl/branch/main/graph/badge.svg?token=0PYHCWVL67)](https://codecov.io/gh/CosmologicalEmulators/Capse.jl)
 ![size](https://img.shields.io/github/repo-size/CosmologicalEmulators/Capse.jl)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)
 [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)

docs/.gitignore

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

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -0,0 +1,22 @@
+using Documenter
+using Capse
+
+ENV["GKSwstype"] = "100"
+
+push!(LOAD_PATH,"../src/")
+
+makedocs(
+    modules = [Capse],
+    format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true",
+    sidebar_sitename=true),
+    sitename = "Capse.jl",
+    authors  = "Marco Bonici",
+    pages = [
+        "Home" => "index.md"
+    ]
+)
+
+deploydocs(
+    repo = "github.com/CosmologicalEmulators/Capse.jl.git",
+    devbranch = "develop"
+)

docs/src/index.md

@@ -0,0 +1,3 @@
+# Capse.jl
+
+Documentation for Capse.jl