Skip to content

Commit 6abd828

Browse files
authored
Update guide.md: remotes=nothing kwarg for local packages (#2616)
1 parent 5049504 commit 6abd828

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/src/man/guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ makedocs(sitename="My Documentation")
8585
```
8686

8787
This assumes you've installed Documenter as discussed in [Installation](@ref) and that your
88-
`Example.jl` package can be found by Julia.
88+
`Example.jl` package can be found by Julia. If your package has been added as a dev
89+
dependency using its local path rather than a remote git repository, you need to add the
90+
keyword argument `remotes = nothing` to the function `makedocs`.
8991

9092
!!! note
9193

0 commit comments

Comments
 (0)