Upgrade to Documenter 1 and fix warnings (#435)

JuliaCI · Oct 17, 2023 · 420dadd · 420dadd
1 parent 087787d
commit 420dadd
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 149 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,4 +3,5 @@
 *.jl.cov
 *.jl.mem
 /Manifest.toml
-/test/fixtures/*/test/Manifest.toml
+/test/fixtures/*/test/Manifest.toml
+/docs/Manifest.toml
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 PkgTemplates = "14b8a8f1-9102-5b29-a752-f990bacb7fe1"
+
+[compat]
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -4,9 +4,9 @@ using PkgTemplates: PkgTemplates
 makedocs(;
     modules=[PkgTemplates],
     authors="Chris de Graaf, Invenia Technical Computing Corporation",
-    repo="https://github.com/JuliaCI/PkgTemplates.jl/blob/{commit}{path}#{line}",
     sitename="PkgTemplates.jl",
     format=Documenter.HTML(;
+        repolink="https://github.com/JuliaCI/PkgTemplates.jl",
         prettyurls=get(ENV, "CI", "false") == "true",
         canonical="https://juliaci.github.io/PkgTemplates.jl",
         assets=String[],

diff --git a/docs/src/developer.md b/docs/src/developer.md
@@ -164,6 +164,7 @@ render_text
 gen_file
 combined_view
 tags
+pkg_name
 ```
 
 For more information on text templating, see the [`FilePlugin` Walkthrough](@ref) and the section on [Custom Template Files](@ref).

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -14,6 +14,10 @@ If you want to **create new plugins**, see the [Developer Guide](developer.md).
 
 if you're trying to **migrate from an older version of PkgTemplates**, see [Migrating To PkgTemplates 0.7+](migrating.md).
 
+```@docs
+PkgTemplates
+```
+
 ## Index
 
 ```@index

diff --git a/docs/src/user.md b/docs/src/user.md
@@ -70,12 +70,17 @@ Coveralls
 
 ### Documentation
 
+These plugins will help you build a documentation website.
+
 ```@docs
 Documenter
 Logo
 ```
 
 ### Badges
+
+These plugins will add badges to the README.
+
 ```@docs
 BlueStyleBadge
 ColPracBadge
@@ -89,6 +94,8 @@ Dependabot
 Develop
 Citation
 RegisterAction
+Formatter
+CodeOwners
 ```
 
 ## A More Complicated Example