From 66818be4418c813ab939efc02f63d7026ef80998 Mon Sep 17 00:00:00 2001 From: carlosperate Date: Wed, 26 Feb 2020 18:49:40 +0000 Subject: [PATCH] Docs: Add more detailed info to the pelican-quickstart path flag. --- docs/install.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 99e72cb7..d683ed8f 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -102,9 +102,12 @@ your site:: pelican-quickstart -If it is running inside a virtual environment it will try to detect the path -associated to it and save the project there. A custom path can be configured -using the ``--path`` flag. +If run inside an activated virtual environment, ``pelican-quickstart`` will +look for an associated project path inside ``$VIRTUAL_ENV/.project``. If that +file exists and contains a valid directory path, the new Pelican project will +be saved at that location. Otherwise, the default is the current working +directory. To set the new project path on initial invocation, use: +``pelican-quickstart --path /your/desired/directory`` Once you finish answering all the questions, your project will consist of the following hierarchy (except for *pages* — shown in parentheses below — which