github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Add more detailed info to the pelican-quickstart path flag.

Browse source
This commit is contained in:
carlosperate 2020-02-26 18:49:40 +00:00
commit 66818be441
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/install.rst
View file

@ -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