From 551909893ef663c602a6562b18d96ec3f33a3c81 Mon Sep 17 00:00:00 2001 From: Steven Maude Date: Thu, 28 May 2015 22:01:05 +0100 Subject: [PATCH 1/2] Document how to use a publish configuration Explain how to import settings from pelicanconf.py into publishconf.py. --- docs/publish.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/publish.rst b/docs/publish.rst index 8c7d4c19..309e8b42 100644 --- a/docs/publish.rst +++ b/docs/publish.rst @@ -61,6 +61,15 @@ feeds, etc.) that you may have defined:: 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. If you have SSH access to a server running Nginx or Apache, you might use the ``rsync`` tool to transmit your site files:: From b6f391d8e93857850faef3e22a0c526945cfb6cf Mon Sep 17 00:00:00 2001 From: Steven Maude Date: Thu, 28 May 2015 22:41:40 +0100 Subject: [PATCH 2/2] Document make publish Also clarify the distinction between make html and make publish. --- docs/publish.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/publish.rst b/docs/publish.rst index 309e8b42..226662ed 100644 --- a/docs/publish.rst +++ b/docs/publish.rst @@ -160,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``, 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 +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 change is detected (which is handy when testing locally), use the following command instead::