From 9c4fdb0e87f418bcc5a504a3245d8a806adb579d Mon Sep 17 00:00:00 2001 From: Nils Gudat Date: Sat, 3 Feb 2024 08:25:56 +0000 Subject: [PATCH] Add `/docs` project to installation instructions (#2429) --- docs/src/man/guide.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/src/man/guide.md b/docs/src/man/guide.md index dfd32f5d5a..056eb2ee21 100644 --- a/docs/src/man/guide.md +++ b/docs/src/man/guide.md @@ -14,6 +14,20 @@ From the Julia REPL, type `]` to enter the Pkg REPL mode and run pkg> add Documenter ``` +For package documentation, the standard approach is to install Documenter into a documentation-specific project stored in the `docs/` subdirectory of your package. +To do this, navigate to your package's root folder and do + +``` +pkg> activate docs/ + +(docs) pkg> add Documenter +``` + +This will create `Project.toml` and `Manifest.toml` files in the `docs/` subdirectory. + +Note that for packages, you also likely need to have your package that you are documenting as a ["dev dependency"](https://pkgdocs.julialang.org/v1/managing-packages/#developing) of the `docs/` environment. + +See also [the Pkg.jl documentation on working with project environments](https://pkgdocs.julialang.org/v1/environments/). ## Setting up the Folder Structure