From bdd6f016963272f6cf8521aafbebc3688ad09482 Mon Sep 17 00:00:00 2001 From: Kazi Abu Rousan Date: Sat, 25 Nov 2023 00:47:34 +0530 Subject: [PATCH] documentation add --- .github/workflows/Documenter.yml | 27 +++++++++++++++++++++++++++ Project.toml | 2 ++ 2 files changed, 29 insertions(+) create mode 100644 .github/workflows/Documenter.yml diff --git a/.github/workflows/Documenter.yml b/.github/workflows/Documenter.yml new file mode 100644 index 0000000..365cd77 --- /dev/null +++ b/.github/workflows/Documenter.yml @@ -0,0 +1,27 @@ +name: Documentation + +on: + push: + branches: + - master # update to match your development branch (master, main, dev, trunk, ...) + tags: '*' + pull_request: + +jobs: + build: + permissions: + contents: write + statuses: write + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: julia-actions/setup-julia@v1 + with: + version: '1.6' + - 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 \ No newline at end of file diff --git a/Project.toml b/Project.toml index 36c458b..8067728 100644 --- a/Project.toml +++ b/Project.toml @@ -5,6 +5,8 @@ version = "1.0.0-DEV" [deps] DifferentialEquations = "0c46a032-eb83-5123-abaf-570d42b7fbaa" +Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" ForwardDiff = "f6369f11-7733-5829-9624-2563aa707210" QuadGK = "1fd47b50-473d-5c70-9696-f719f8f3bcdc" ReverseDiff = "37e2e3b7-166d-5795-8a7a-e32c996b4267"