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

Merge pull request #1726 from StevenMaude/add-settings-details-to-publish-docs

Browse source 
Add publishconf.py, "make publish" details to docs
This commit is contained in:
Justin Mayer 2015-06-04 15:27:22 -07:00
commit 69b8a2d8cc
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/publish.rst
View file

@ -61,6 +61,15 @@ feeds, etc.) that you may have defined::
pelican content -s publishconf.py pelican content -s publishconf.py
To base your publish configuration on top of your ``pelicanconf.py``, you
can import your ``pelicanconf`` settings by including the following line in
your ``publishconf.py``::
from pelicanconf import *
If you have generated a ``publishconf.py`` using ``pelican-quickstart``,
this line is included by default.
The steps for deploying your site will depend on where it will be hosted. The steps for deploying your site will depend on where it will be hosted.
If you have SSH access to a server running Nginx or Apache, you might use the If you have SSH access to a server running Nginx or Apache, you might use the
``rsync`` tool to transmit your site files:: ``rsync`` tool to transmit your site files::
@ -151,10 +160,16 @@ and thus doesn't require installing anything else in order to use it. The
downside is that non-POSIX systems (e.g., Windows) do not include ``make``, downside is that non-POSIX systems (e.g., Windows) do not include ``make``,
and installing it on those systems can be a non-trivial task. and installing it on those systems can be a non-trivial task.
If you want to use ``make`` to generate your site, run:: If you want to use ``make`` to generate your site using the settings in
``pelicanconf.py``, run::
make html make html
To generate the site for production, using the settings in ``publishconf.py``,
run::
make publish
If you'd prefer to have Pelican automatically regenerate your site every time a If you'd prefer to have Pelican automatically regenerate your site every time a
change is detected (which is handy when testing locally), use the following change is detected (which is handy when testing locally), use the following
command instead:: command instead::