diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..7136718 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -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 diff --git a/docs/Manifest.toml b/docs/Manifest.toml index d725da5..b59e44e 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -2,7 +2,7 @@ julia_version = "1.10.2" manifest_format = "2.0" -project_hash = "aa51543ac8436e6e88020ded35ef6ec1e89249e9" +project_hash = "9516226bf0680f7d199d1dfec4ca8be000a65a83" [[deps.ANSIColoredPrinters]] git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c" diff --git a/docs/Project.toml b/docs/Project.toml index 04a94f0..e30f8c4 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -2,3 +2,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" InformativeSampling = "bfd01cc8-db36-4de5-b056-8ab04eef9441" InformativeSamplingUtils = "1d6b69be-e25c-46ac-b1c5-442f720809e4" + +[compat] +Documenter = "1.5" diff --git a/docs/make.jl b/docs/make.jl index fd7cdf4..6d5d333 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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", @@ -19,3 +19,8 @@ makedocs( ], format = Documenter.HTML(prettyurls=false) ) + +deploydocs( + repo = "github.com/ngharrison/InformativeSampling.git", + versions = nothing, +) diff --git a/readme.org b/readme.org index 315f063..c812a20 100644 --- a/readme.org +++ b/readme.org @@ -147,6 +147,8 @@ Note that just the same as when running Julia code normally, if the interpreter * Documentation +The docs can be viewed at https://ngharrison.github.io/InformativeSampling/. + If you want to view the docs locally, first generate them by running the following command(s) from the project root: #+begin_src shell