Skip to content

Commit

Permalink
feat: adding github doc generation and hosting
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholas Harrison committed Nov 4, 2024
1 parent 3a24213 commit 69307e8
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 8 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Documentation

on:
push:
branches:
- main
tags: '*'
pull_request:

jobs:
build:
permissions:
actions: write
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@v2
- name: Install dependencies
run: julia --project=docs -e 'using Pkg; Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: julia --project=docs docs/make.jl
2 changes: 1 addition & 1 deletion app/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

julia_version = "1.10.2"
manifest_format = "2.0"
project_hash = "cd36817b8538fc312da91b5b162a3a353cac0667"
project_hash = "beba688800eb88807105e3e6656a2c23b0642ab4"

[[deps.AbstractFFTs]]
deps = ["LinearAlgebra"]
Expand Down
3 changes: 3 additions & 0 deletions app/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@ RobotOS = "22415677-39a4-5241-a37a-00beabbbdae8"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"

[compat]
julia = "1.10"
2 changes: 1 addition & 1 deletion core/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

julia_version = "1.10.2"
manifest_format = "2.0"
project_hash = "758601bb8456cc690f0d7b683e23b43f6a69e408"
project_hash = "6900ff5779df6772d57684bb92c77ff72c5f472d"

[[deps.AbstractGPs]]
deps = ["ChainRulesCore", "Distributions", "FillArrays", "IrrationalConstants", "KernelFunctions", "LinearAlgebra", "PDMats", "Random", "RecipesBase", "Reexport", "Statistics", "StatsBase", "Test"]
Expand Down
2 changes: 1 addition & 1 deletion core/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

[compat]
julia = ">= 1.9"
julia = "1.10"
2 changes: 1 addition & 1 deletion docs/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

julia_version = "1.10.2"
manifest_format = "2.0"
project_hash = "aa51543ac8436e6e88020ded35ef6ec1e89249e9"
project_hash = "25d1a1d57998e7598cd36425565319cd4fc45239"

[[deps.ANSIColoredPrinters]]
git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c"
Expand Down
4 changes: 4 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
InformativeSampling = "bfd01cc8-db36-4de5-b056-8ab04eef9441"
InformativeSamplingUtils = "1d6b69be-e25c-46ac-b1c5-442f720809e4"

[compat]
julia = "1.10"
Documenter = "1.5"
9 changes: 7 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ using InformativeSampling: Maps, Missions, BeliefModels, Kernels,
using InformativeSamplingUtils: DataIO, Visualization, Metrics

makedocs(
sitename="InformativeSampling.jl",
remotes=nothing,
sitename="InformativeSampling",
# remotes=nothing,
pages = [
"index.md",
"application.md",
Expand All @@ -19,3 +19,8 @@ makedocs(
],
format = Documenter.HTML(prettyurls=false)
)

deploydocs(
repo = "github.com/ngharrison/InformativeSampling.git",
versions = nothing,
)
2 changes: 1 addition & 1 deletion utils/Manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

julia_version = "1.10.2"
manifest_format = "2.0"
project_hash = "2f3d2b14f2dd149f452899fadc3387062e44ea71"
project_hash = "f94307accf23328b8d4e5ef5983a31ec58f0c1a7"

[[deps.AbstractFFTs]]
deps = ["LinearAlgebra"]
Expand Down
2 changes: 1 addition & 1 deletion utils/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

[compat]
julia = ">= 1.9"
julia = "1.10"

0 comments on commit 69307e8

Please sign in to comment.