weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity
pelican-theme/pelican/tools/templates/Makefile.in

123 lines
4.3 KiB
Makefile
Raw Normal View History

PY and PELICAN env variable overrides for Make This allows the user to set PY and/or PELICAN environment variable overrides, which will be respected by the Makefile and devserver.sh. If, for example, the default Python on your system were Python 3 and you wanted to run Make with Python 2, using bash you could run `PY=python2 make`. Refs #915.
2014-02-08 14:32:58 -08:00
PELICAN?=$pelican
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
PELICANOPTS=$pelicanopts
Improve devserver durability. Refs #473. Three changes: 1. Fix inconsistent "pwd" behavior by using make's $(CURDIR) builtin. 2. Change bash shebang to the more-portable form. 3. Tell users when Pelican and SimpleHTTPServer have been backgrounded.
2012-08-27 13:09:25 -07:00
BASEDIR=$$(CURDIR)
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
INPUTDIR=$$(BASEDIR)/content
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
OUTPUTDIR=$$(BASEDIR)/output
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
CONFFILE=$$(BASEDIR)/pelicanconf.py
PUBLISHCONF=$$(BASEDIR)/publishconf.py
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
FTP_HOST=$ftp_host
FTP_USER=$ftp_user
FTP_TARGET_DIR=$ftp_target_dir
SSH_HOST=$ssh_host
Support arbitrary SSH ports in pelican-quickstart Some folks choose non-standard SSH ports for security reasons, so it makes sense to try to support that in the pelican-quickstart script.
2012-07-05 11:34:45 -07:00
SSH_PORT=$ssh_port
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
SSH_USER=$ssh_user
SSH_TARGET_DIR=$ssh_target_dir
Added S3 support for pelican quickstart.
2013-03-15 15:04:33 +11:00
S3_BUCKET=$s3_bucket
Adds Rackspace Cloud Files support to quickstart and fabfile
2013-06-11 21:43:23 -05:00
CLOUDFILES_USERNAME=$cloudfiles_username
CLOUDFILES_API_KEY=$cloudfiles_api_key
CLOUDFILES_CONTAINER=$cloudfiles_container
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
DROPBOX_DIR=$dropbox_dir
Support publishing to personal pages sites in quickstart Previously pelican-quickstart would assume that the site it created for GitHub Pages should be published to the gh-pages branch. This is correct for project pages, but not correct for personal pages. Personal pages, which live in a user's special username.github.io repository, are instead deployed to the master branch. This means that if you did pelican-quickstart and tried to publish your new personal site with make github you'd see nothing (or whatever old pages site you had floating around in master). ghp-import already supports publishing to different branches, so publishing to the correct branch is just a matter of correct configuration and updating the Makefile to pass the branch along to ghp-import. pelican-quickstart now asks if the user wants to publish to GitHub Pages, and if so, asks if this is a personal page and chooses the correct branch appropriately. I preferred this approach to prompting for an arbitrary branch because I felt that choosing the branch would feel more intimidating to someone using pelican-quickstart for the first time. This essentially ports changes I made to my personal pages site at jculpon@82cae477a9e8712b90654f6432464369ebcc7ae5
2013-12-06 17:39:51 -08:00
GITHUB_PAGES_BRANCH=$github_pages_branch
Add debug target to the template makefile If the DEBUG variable is set (e.g. DEBUG=1 make target) debugging will be enabled by using pelicans -D flag.
2013-06-26 13:25:20 +02:00
DEBUG ?= 0
ifeq ($(DEBUG), 1)
PELICANOPTS += -D
Correct upload targets in Makefile.in
2013-08-29 17:35:48 -07:00
endif
Add debug target to the template makefile If the DEBUG variable is set (e.g. DEBUG=1 make target) debugging will be enabled by using pelicans -D flag.
2013-06-26 13:25:20 +02:00
add argparse argument for relative urls
2015-01-17 16:37:11 +01:00
RELATIVE ?= 0
ifeq ($(RELATIVE), 1)
PELICANOPTS += --relative-urls
endif
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
help:
Adding ability to listen on addresses other than localhost. This is helpful for mobile testing of Pelican sites by allowing broadcasting on the local network. Using port 80 requires running as root on most machines.
2015-01-10 15:40:54 -08:00
@echo 'Makefile for a pelican Web site '
@echo ' '
@echo 'Usage: '
@echo ' make html (re)generate the web site '
@echo ' make clean remove the generated files '
@echo ' make regenerate regenerate files upon modification '
@echo ' make publish generate using production settings '
@echo ' make serve [PORT=8000] serve site at http://localhost:8000'
@echo ' make serve-global [SERVER=0.0.0.0] serve (as root) to $(SERVER):80 '
@echo ' make devserver [PORT=8000] start/restart develop_server.sh '
@echo ' make stopserver stop local server '
@echo ' make ssh_upload upload the web site via SSH '
@echo ' make rsync_upload upload the web site via rsync+ssh '
@echo ' make dropbox_upload upload the web site via Dropbox '
@echo ' make ftp_upload upload the web site via FTP '
@echo ' make s3_upload upload the web site via S3 '
@echo ' make cf_upload upload the web site via Cloud Files'
@echo ' make github upload the web site via gh-pages '
@echo ' '
@echo 'Set the DEBUG variable to 1 to enable debugging, e.g. make DEBUG=1 html '
add argparse argument for relative urls
2015-01-17 16:37:11 +01:00
@echo 'Set the RELATIVE variable to 1 to enable relative urls '
Adding ability to listen on addresses other than localhost. This is helpful for mobile testing of Pelican sites by allowing broadcasting on the local network. Using port 80 requires running as root on most machines.
2015-01-10 15:40:54 -08:00
@echo ' '
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
Remove "clean" task from "make html"; fixes #637 This change removes the "clean" task from the "html" and "regenerate" tasks in the default Makefile generated by pelican-quickstart. The previous behavior ignored whether the DELETE_OUTPUT_DIRECTORY setting was set to True or not and deleted everything in the output directory every time the "make html" or "make regenerate" task was run. In addition to violating the Principle of Least Astonishment, there was also the potential for data loss if the user wasn't careful when defining the output directory location in the Makefile. The new behavior therefore relies primarily on the DELETE_OUTPUT_DIRECTORY setting to control if and when the output directory is cleaned. The default settings and Makefile generated by the pelican-quickstart command, for example, no longer clean the output directory when the "make html" task is run. If the user wants to change this behavior and have the output directory cleaned on every "make html" run, the recommended method would be to set DELETE_OUTPUT_DIRECTORY to True in pelicanconf.py. Alternatively, the user can manually run "make clean", with the caveat that the output directory and its contents will be entirely destroyed, including any otherwise to-be-retained files or folders specified in the OUTPUT_RETENTION setting. It is for that reason that relying on the DELETE_OUTPUT_DIRECTORY setting is instead recommended. As before, DELETE_OUTPUT_DIRECTORY is set to True in the publishconf.py settings file generated by the pelican-quickstart script. This way, any potentially old and irrelevant files will be automatically removed before the latest version of the site is transferred to the production server environment. In summary, this change allows for the sanest possible default settings, while still allowing end users to customize output cleaning to their preferred behavior with a minimum of confusion.
2013-06-24 13:05:00 -07:00
html:
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
$$(PELICAN) $$(INPUTDIR) -o $$(OUTPUTDIR) -s $$(CONFFILE) $$(PELICANOPTS)
clean:
Revert "make clean" behavior to rm -rf. Fixes #773 The change to the "make clean" task in 764a2cf from "rm -rf" to instead relying on GNU "find" appears to have broken cross-platform portability, likely causing problems on *BSD and other platforms. This commit reverts that change back to the previous "rm -rf" behavior.
2013-06-24 13:40:32 -07:00
[ ! -d $$(OUTPUTDIR) ] || rm -rf $$(OUTPUTDIR)
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
Remove "clean" task from "make html"; fixes #637 This change removes the "clean" task from the "html" and "regenerate" tasks in the default Makefile generated by pelican-quickstart. The previous behavior ignored whether the DELETE_OUTPUT_DIRECTORY setting was set to True or not and deleted everything in the output directory every time the "make html" or "make regenerate" task was run. In addition to violating the Principle of Least Astonishment, there was also the potential for data loss if the user wasn't careful when defining the output directory location in the Makefile. The new behavior therefore relies primarily on the DELETE_OUTPUT_DIRECTORY setting to control if and when the output directory is cleaned. The default settings and Makefile generated by the pelican-quickstart command, for example, no longer clean the output directory when the "make html" task is run. If the user wants to change this behavior and have the output directory cleaned on every "make html" run, the recommended method would be to set DELETE_OUTPUT_DIRECTORY to True in pelicanconf.py. Alternatively, the user can manually run "make clean", with the caveat that the output directory and its contents will be entirely destroyed, including any otherwise to-be-retained files or folders specified in the OUTPUT_RETENTION setting. It is for that reason that relying on the DELETE_OUTPUT_DIRECTORY setting is instead recommended. As before, DELETE_OUTPUT_DIRECTORY is set to True in the publishconf.py settings file generated by the pelican-quickstart script. This way, any potentially old and irrelevant files will be automatically removed before the latest version of the site is transferred to the production server environment. In summary, this change allows for the sanest possible default settings, while still allowing end users to customize output cleaning to their preferred behavior with a minimum of confusion.
2013-06-24 13:05:00 -07:00
regenerate:
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
$$(PELICAN) -r $$(INPUTDIR) -o $$(OUTPUTDIR) -s $$(CONFFILE) $$(PELICANOPTS)
serve:
add port option to Makefile target serve/devserver
2013-07-07 14:28:15 +02:00
ifdef PORT
cd $$(OUTPUTDIR) && $(PY) -m pelican.server $$(PORT)
else
make pelican-quickstart and the Makefile it generates support py3k.
2013-02-01 15:35:48 -08:00
cd $$(OUTPUTDIR) && $(PY) -m pelican.server
add port option to Makefile target serve/devserver
2013-07-07 14:28:15 +02:00
endif
Give devserver its own make target Restore "make serve" to a non-backgrounded SimpleHTTPServer process and give the develop_server.sh its own make target at "make devserver". Add a few missing make targets to the help list and re-order targets for consistency. Add note to docs regarding how to stop the devserver.
2012-08-05 17:25:39 -07:00
Adding ability to listen on addresses other than localhost. This is helpful for mobile testing of Pelican sites by allowing broadcasting on the local network. Using port 80 requires running as root on most machines.
2015-01-10 15:40:54 -08:00
serve-global:
ifdef SERVER
cd $$(OUTPUTDIR) && $(PY) -m pelican.server 80 $$(SERVER)
else
cd $$(OUTPUTDIR) && $(PY) -m pelican.server 80 0.0.0.0
endif
Give devserver its own make target Restore "make serve" to a non-backgrounded SimpleHTTPServer process and give the develop_server.sh its own make target at "make devserver". Add a few missing make targets to the help list and re-order targets for consistency. Add note to docs regarding how to stop the devserver.
2012-08-05 17:25:39 -07:00
devserver:
add port option to Makefile target serve/devserver
2013-07-07 14:28:15 +02:00
ifdef PORT
$$(BASEDIR)/develop_server.sh restart $$(PORT)
else
Added the delevop_server script This script and the small changes to quick start's makefile make for easily launching and killing of pelican --debug --autoreload and SimpleHTTPServer. This is extra useful for working on templates.
2012-07-08 17:50:18 -07:00
$$(BASEDIR)/develop_server.sh restart
add port option to Makefile target serve/devserver
2013-07-07 14:28:15 +02:00
endif
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
adding a stopsever target for make
2013-02-21 12:43:42 +01:00
stopserver:
Actually stopping server When running `make devserver` and then running `make stopserver` it doesn't stop the server. This patch fixes that.
2015-05-24 16:59:23 +01:00
$(BASEDIR)/develop_server.sh stop
Fixed the stopserver command to use the correct Makefile syntax
2013-03-09 21:27:19 +00:00
@echo 'Stopped Pelican and SimpleHTTPServer processes running in background.'
adding a stopsever target for make
2013-02-21 12:43:42 +01:00
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
publish:
$$(PELICAN) $$(INPUTDIR) -o $$(OUTPUTDIR) -s $$(PUBLISHCONF) $$(PELICANOPTS)
ssh_upload: publish
Support arbitrary SSH ports in pelican-quickstart Some folks choose non-standard SSH ports for security reasons, so it makes sense to try to support that in the pelican-quickstart script.
2012-07-05 11:34:45 -07:00
scp -P $$(SSH_PORT) -r $$(OUTPUTDIR)/* $$(SSH_USER)@$$(SSH_HOST):$$(SSH_TARGET_DIR)
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
rsync_upload: publish
Fix #1277 use rsync -c option as all output is rewritten Because Pelican always rewrites all output, the mtimes always change, so rsync would always transfer all the files which defeats the purpose of rsync. The '-c' option (--checksum) compares the checksums rather than mtimes.
2014-04-28 21:47:18 +02:00
rsync -e "ssh -p $(SSH_PORT)" -P -rvzc --delete $(OUTPUTDIR)/ $(SSH_USER)@$(SSH_HOST):$(SSH_TARGET_DIR) --cvs-exclude
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
Give devserver its own make target Restore "make serve" to a non-backgrounded SimpleHTTPServer process and give the develop_server.sh its own make target at "make devserver". Add a few missing make targets to the help list and re-order targets for consistency. Add note to docs regarding how to stop the devserver.
2012-08-05 17:25:39 -07:00
dropbox_upload: publish
cp -r $$(OUTPUTDIR)/* $$(DROPBOX_DIR)
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
ftp_upload: publish
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
lftp ftp://$$(FTP_USER)@$$(FTP_HOST) -e "mirror -R $$(OUTPUTDIR) $$(FTP_TARGET_DIR) ; quit"
Added S3 support for pelican quickstart.
2013-03-15 15:04:33 +11:00
s3_upload: publish
fix missing tab in Makefile template
2014-10-20 15:22:11 +02:00
s3cmd sync $(OUTPUTDIR)/ s3://$(S3_BUCKET) --acl-public --delete-removed --guess-mime-type
Added S3 support for pelican quickstart.
2013-03-15 15:04:33 +11:00
Adds Rackspace Cloud Files support to quickstart and fabfile
2013-06-11 21:43:23 -05:00
cf_upload: publish
cd $(OUTPUTDIR) && swift -v -A https://auth.api.rackspacecloud.com/v1.0 -U $(CLOUDFILES_USERNAME) -K $(CLOUDFILES_API_KEY) upload -c $(CLOUDFILES_CONTAINER) .
Add dual dev/publish modes to quickstart script Certain configuration options are more useful in production than they are in development. Some examples might be absolute URLs, external analytics service identifiers, Disqus comments, etc. This version of the quickstart script creates two configuration files: one for development and the other for use when publishing. In addition, the related docs have been expanded considerably. Last but not least, the quickstart script will now detect whether there is a project folder associated with the currently active virtualenv (if any) and use it by default.
2012-07-07 07:41:12 -07:00
github: publish
update make github commit message
2014-06-29 17:00:33 +02:00
ghp-import -m "Generate Pelican site" -b $(GITHUB_PAGES_BRANCH) $$(OUTPUTDIR)
Support publishing to personal pages sites in quickstart Previously pelican-quickstart would assume that the site it created for GitHub Pages should be published to the gh-pages branch. This is correct for project pages, but not correct for personal pages. Personal pages, which live in a user's special username.github.io repository, are instead deployed to the master branch. This means that if you did pelican-quickstart and tried to publish your new personal site with make github you'd see nothing (or whatever old pages site you had floating around in master). ghp-import already supports publishing to different branches, so publishing to the correct branch is just a matter of correct configuration and updating the Makefile to pass the branch along to ghp-import. pelican-quickstart now asks if the user wants to publish to GitHub Pages, and if so, asks if this is a personal page and chooses the correct branch appropriately. I preferred this approach to prompting for an arbitrary branch because I felt that choosing the branch would feel more intimidating to someone using pelican-quickstart for the first time. This essentially ports changes I made to my personal pages site at jculpon@82cae477a9e8712b90654f6432464369ebcc7ae5
2013-12-06 17:39:51 -08:00
git push origin $(GITHUB_PAGES_BRANCH)
Moved templates in pelican_quistart.py to a directory
2012-05-06 12:07:13 +02:00
Adding ability to listen on addresses other than localhost. This is helpful for mobile testing of Pelican sites by allowing broadcasting on the local network. Using port 80 requires running as root on most machines.
2015-01-10 15:40:54 -08:00
.PHONY: html help clean regenerate serve serve-global devserver publish ssh_upload rsync_upload dropbox_upload ftp_upload s3_upload cf_upload github
Copy permalink