Add Documenter documentation (JuliaIO#178)

* Add documentation * Tweak docstring * Add urls to readme --------- Co-authored-by: Steve Kelly <[email protected]>
mechanomy · Jul 4, 2023 · d2bb7d1 · d2bb7d1
1 parent 968d24e
commit d2bb7d1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
@@ -8,7 +8,7 @@ on:
     paths-ignore:
       - 'README.md'
     branches:
-      - 'master'
+      - 'main'
       - 'release-'
     tags: '*'
 
@@ -40,7 +40,8 @@ jobs:
             Pkg.instantiate()'
       - name: BuildAndDeploy
         env:
-          JULIA_PKG_SERVER: ""
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+# https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#Authentication:-GITHUB_TOKEN
+#         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
         run: julia --project=docs/ docs/make.jl
diff --git a/README.md b/README.md
@@ -94,3 +94,10 @@ close(file)
 ## Credits
 
 The MAT_HDF5 module, which provides read/write support for MATLAB v7.3 files, was written primarily by [Tim Holy](https://github.com/timholy/). The MAT_v5 module, which provides read support for MATLAB v5/v6/v7 files, was written primarily by [Simon Kornblith](https://github.com/simonster/). The MAT_v4 module, which provides read and write support for MATLAB v4 files, was written primarily by [Victor Saase](https://github.com/vsaase/).
+
+
+<!-- URLs -->
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://JuliaIO.github.io/MAT.jl/stable
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://JuliaIO.github.io/MAT.jl/dev
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,6 +1,6 @@
 execute = isempty(ARGS) || ARGS[1] == "run"
 
-org, reps = :JuliaIO, :MAT
+org, reps = :JuilaIO, :MAT
 eval(:(using $reps))
 using Documenter
 using Literate
@@ -65,8 +65,8 @@ makedocs(;
 
 if isci
     deploydocs(;
-        repo = "github.com/JuliaIO/MAT.jl",
-        devbranch = "master",
+        repo = "github.com/$base",
+        devbranch = "main",
         devurl = "dev",
         versions = ["stable" => "v^", "dev" => "dev"],
         forcepush = true,