Update guide.md: remotes=nothing kwarg for local packages

JuliaDocs · Dec 30, 2024 · 3dfb698 · 3dfb698
1 parent 5049504
commit 3dfb698
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/docs/src/man/guide.md b/docs/src/man/guide.md
@@ -85,7 +85,9 @@ makedocs(sitename="My Documentation")
 ```
 
 This assumes you've installed Documenter as discussed in [Installation](@ref) and that your
-`Example.jl` package can be found by Julia.
+`Example.jl` package can be found by Julia. If your package has been added as a dev
+dependency using its local path rather than a remote git repository, you need to add the
+keyword argument `remotes = nothing` to the function `makedocs`.
 
 !!! note