Skip to content

Commit

Permalink
add key to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
swang22 committed Feb 2, 2024
1 parent 5770a9a commit 8714d2c
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 3 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Documentation

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

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
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
2 changes: 2 additions & 0 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
Distances = "b4f34e82-e78d-54a5-968a-f98e89d6e8f7"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
HiGHS = "87dc4568-4c63-4d18-b0c0-bb2238e4078b"
JuMP = "4076af6c-e467-56ae-b986-b466b2749572"
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ pages = OrderedDict(

makedocs(;
modules=[HOPE],
authors="swang22 <[email protected]> and contributors",
repo="https://github.com/SW/HOPE.jl/blob/{commit}{path}#{line}",
authors="Shen Wang, Mahdi Mehrtash, Zoe Song and contributors",
#repo="https://github.com/SW/HOPE.jl/blob/{commit}{path}#{line}",
sitename="HOPE.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
Expand All @@ -32,6 +32,6 @@ makedocs(;
)

deploydocs(;
repo="github.com/SW/HOPE.jl",
repo="github.com/swang22/HOPE",
devbranch="master",
)

0 comments on commit 8714d2c

Please sign in to comment.