Fix documentation (#190 with preview) (#193)

* remove mkdocs.yml

* update docs/make.jl

* Add preview

* Update CI

* Fix repo url

Co-authored-by: hyrodium <hyrodium@gmail.com>

Author: devmotion

.github/workflows/DocsPreviewCleanup.yml

@@ -0,0 +1,27 @@
+name: Docs Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "documenter@juliadocs.github.io"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}
+

.github/workflows/ci.yml

@@ -1,4 +1,5 @@
 name: CI
+
 on:
   pull_request:
     branches:
@@ -7,6 +8,13 @@ on:
     branches:
       - master
     tags: '*'
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}

docs/make.jl

@@ -1,3 +1,21 @@
 using Documenter, ReverseDiff
 
-makedocs(modules=[ReverseDiff], sitename="http://www.juliadiff.org/ReverseDiff.jl")
+makedocs(;
+    modules=[ReverseDiff],
+    sitename="ReverseDiff.jl",
+    format=Documenter.HTML(;
+        prettyurls=get(ENV, "CI", nothing) == "true",
+        canonical="http://www.juliadiff.org/ReverseDiff.jl",
+    ),
+    pages=[
+        "Home" => "index.md",
+        "Limitation of ReverseDiff" => "limits.md",
+        "API" => "api.md",
+    ],
+    strict=true,
+    checkdocs=:exports,
+)
+
+deploydocs(;
+    repo="github.com/JuliaDiff/ReverseDiff.jl", push_preview=true,
+)