Docs: Setup to deploy site on github page

iagoleal · iagoleal · commit 6930a129a76f · 2020-03-13T00:36:56.000-03:00
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,23 @@
+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.3
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+        run: julia --project=docs/ docs/make.jl
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 *.gif
 Manifest.toml
+docs/build/
+docs/site/
diff --git a/docs/make.jl b/docs/make.jl
@@ -25,35 +25,36 @@ for data in ("logo" => "black", "logo-dark" => "white")
         println("Sucessfully created asset: $(data.first).")
     end
 end
+
 # Turn logo into icon
 if !isfile(joinpath(assets_dir, "favicon.ico")) && isfile(joinpath(assets_dir, "logo.svg"))
     run(`convert -background none $(joinpath(assets_dir, "logo.svg")) -define icon:auto-resize $(joinpath(assets_dir, "favicon.ico"))`)
     println("Sucessfully created asset: ico.")
 end
+
+# Set the right metadata for doctests
 DocMeta.setdocmeta!(DeformableBodies, :DocTestSetup, :(using DeformableBodies); recursive=true)
 
 makedocs(
     sitename = "DeformableBodies.jl",
     authors  = "Iago Leal de Freitas",
     format   = Documenter.HTML(
-        prettyurls = get(ENV, "CI", nothing) == "true",
-        assets     = ["assets/favicon.ico"]
+        prettyurls = !("local" in ARGS),    # Deactivate on local builds
+        assets     = ["assets/favicon.ico"],
+        canonical  = "https://iagoleal.github.io/DeformableBodies.jl/dev/"
     ),
     modules  = [DeformableBodies, DeformableBodies.Quaternions],
     pages    = [
         "Introduction" => "index.md",
         "Tutorial" => "tutorial-cubecopter.md",
-        "theory.md",
         "Reference" => [
             "Quaternions" => "ref-quaternions.md",
             "DeformableBodies" => "ref-models.md"
         ]
    ]
 )
 
-# Documenter can also automatically deploy documentation to gh-pages.
-# See "Hosting Documentation" and deploydocs() in the Documenter manual
-# for more information.
-#=deploydocs(
-    repo = "<repository url>"
-)=#
+# Deploy site to Github Pages
+deploydocs(
+    repo = "github.com/iagoleal/DeformableBodies.jl.git",
+)
diff --git a/docs/src/theory.md b/docs/src/theory.md
