Commit graph

181 commits

Author SHA1 Message Date
Danilo Bargen
931d571606 More explicit settings docs concerning list templates
I think the author list and tag list are so common that they should be
listed explicitly in the settings.
2013-06-28 00:55:22 +02:00
Justin Mayer
6f36b0a246 Keep certain files when cleaning output; fix #574
If DELETE_OUTPUT_DIRECTORY is set to True, all files and directories are
deleted from the output directory. There are, however, several reasons
one might want to retain certain files/directories and avoid their
deletion from the output directory. One such use case is version control
system data: a versioned output directory can facilitate deployment via
Heroku and/or allow the user to easily revert to a prior version of the
site without having to rely on regeneration via Pelican.

This change introduces the OUTPUT_RETENTION setting, a tuple of
filenames that will be preserved when the clean_output_dir function in
pelican.utils is run. Setting OUTPUT_RETENTION = (".hg", ".git") would,
for example, prevent the relevant VCS data from being deleted when the
output directory is cleaned.
2013-06-25 19:03:32 -07:00
W. Trevor King
ce0a9b697e Document path metadata extraction 2013-06-12 17:37:22 -04:00
W. Trevor King
d43dc1b9d6 Add the EXTRA_PATH_METADATA setting
Useful for altering static output paths when you don't want to encode
extra metadata in the static file's source path.
2013-06-12 15:02:31 -04:00
W. Trevor King
1ca0e06a27 Remove the FILES_TO_COPY setting
We no longer instantiate the Static object in the StaticGenerator, so
we can't set the save_as argument anymore.  If you want to adjust the
output path, use the upcoming EXTRA_PATH_METADATA setting.
2013-06-12 15:02:31 -04:00
Justin Mayer
1fcf4a6550 Add documentation for ARCHIVES_SAVE_AS setting
While this setting has existed for some time, there does not seem to
have been any documentation for it until now.
2013-06-10 19:42:53 -07:00
Justin Mayer
34f05d4ba6 Add warning to docs re: DELETE_OUTPUT_DIRECTORY 2013-05-02 17:18:19 -07:00
Deniz Turgut
be8837963a ignore emacs lock files and exception handling for watchers 2013-04-22 20:50:11 -04:00
Emily Strickland
08f27e0134 Accept mdown file extension for Markdown files.
This extension is sometimes used for Markdown files and is the default
for a few editors, such as Sublime Text.
2013-04-17 21:14:52 -07:00
Justin Mayer
8be7c0dbae Minor documentation improvements 2013-04-16 10:13:47 -07:00
Justin Mayer
0a8678a8ae Change RELATIVE_URLS default to False - Fixes #829 2013-04-11 16:12:55 -07:00
Deniz Turgut
9936538d8b unify css class for pygments 2013-04-02 18:39:52 -04:00
David Beitey
e042e11c23 Add new option for controlling whether to display categories on menu or not
Conflicts:
	docs/changelog.rst
	pelican/tests/output/basic/tag/bar.html
	pelican/tests/output/basic/tag/baz.html
	pelican/tests/output/basic/tag/foo.html
	pelican/tests/output/custom/tag/bar.html
	pelican/tests/output/custom/tag/baz.html
	pelican/tests/output/custom/tag/foo.html
2013-04-01 22:08:13 +10:00
Justin Mayer
c7f06b9af6 Merge pull request #786 from noirbizarre/more-documentation
Add missing documentation for JINJA_FILTERS and SITESUBTITLE
2013-03-20 13:29:13 -07:00
Axel Haustant
e235cadda4 Fix typos 2013-03-20 21:21:47 +01:00
Justin Mayer
439b783a72 Merge pull request #785 from wraithan/docs_for_ignore_files
documentation for IGNORE_FILES
2013-03-20 09:07:58 -07:00
Axel Haustant
7fb51e94bb Fix typos 2013-03-20 16:08:54 +01:00
Axel Haustant
c36fce8b6a Added missing SITESUBTITLE documentation 2013-03-19 14:58:35 +01:00
Axel Haustant
c6b943bfe9 Added missing JINJA_FILTERS documentation 2013-03-19 14:58:35 +01:00
Wraithan (Chris McDonald)
e73f7e9f84 documentation for IGNORE_FILES 2013-03-18 17:51:17 -07:00
John Mastro
f92c800216 Add a period archives feature and brief docs.
Allows users to have per-year, per-month, and per-day archives of posts
automatically generated. The feature is disabled by default; to enable
it a user must supply format strings for a period's respective
`_SAVE_AS` setting.
2013-03-15 17:22:42 -07:00
W. Trevor King
bfa8851af0 Add the PATH_METADATA setting
Sometimes the base filename doesn't have everything you need.

Remember that os.sep is platform dependent, so using it in a regular
expression for this setting may not be portable (boo MS Windows!).
2013-03-12 15:16:25 -07:00
Jered Boxman
bfaa5f9d5c Added clearification in docs for PAGE_SAVE_AS
I discussed this option in the IRC channel, because I don't think it's
very clear. When I first read the list of options I was under the
impression that Pelican could do rewriting of urls. I discovered that
this isn't the case, so I discusses this in the IRC channel and got the
encouragement to submit a pull request.
2013-03-10 14:34:17 +01:00
Eric
7cafcf6c24 Fix the tag cloud example 2013-03-05 23:27:00 -08:00
Valentin-Costel Hăloiu
64ce845bae Fix typo 2013-02-10 00:38:18 +02:00
Justin Mayer
a07b56c02b Doc fixes and improvements 2012-12-03 16:31:55 -08:00
Bruno Binet
8bb86d3e5d revert #523
we don't need a new MARKDOWN_EXTENSIONS setting because the equivalent setting
MD_EXTENSIONS already exists.
2012-12-03 22:35:11 +01:00
Bruno Binet
f86e1128f0 docfix: fix example of FILENAME_METADATA regexp 2012-12-03 10:20:43 +01:00
Bruno Binet
3a25f82c4f update docs/settings.rst for both DEFAULT_METADATA and FILENAME_METADATA 2012-12-03 09:53:14 +01:00
Brian C. Lane
49f481e399 Add asciidoc reader support
http://www.methods.co.nz/asciidoc/index.html

Processes files ending in .asc with asciidoc. Extra arguments can be
passed by using the ASCIIDOC_OPTIONS config setting
2012-12-02 10:20:13 -08:00
Bruno Binet
fa82e19c1f change default value for DEFAULT_DATE to None
(was 'fs' => guess from file mtime)
2012-11-28 00:29:51 +01:00
Michael Reneer
103ae436c9 Update docs/settings.rst
Updated commit based on the discussion in the pull request.
2012-11-26 13:03:25 -05:00
Michael Reneer
4de668159d Update docs/settings.rst
Updated the documentation for the MARKUP setting to reflect the current supported markup file extensions.
2012-11-26 11:26:33 -05:00
Bruno Binet
801bc755b5 Merge branch 'pr/558'
Conflicts:
	docs/settings.rst
	pelican/signals.py
2012-11-23 15:32:17 +01:00
Alexis Métaireau
5523240553 What would be a commit without his "fix typo" brother, uh? 2012-11-15 20:09:21 +01:00
Alexis Métaireau
43b1555e5d Mention that FILES_TO_COPY is able to copy dirs. 2012-11-15 20:07:08 +01:00
Bruno Binet
ec42fa837f docfix: fix default values for _URL and _SAVE_AS settings
(AUTHOR_URL, AUTHOR_SAVE_AS, CATEGORY_URL, CATEGORY_SAVE_AS)
2012-11-13 01:46:43 +01:00
Bruno Binet
e56d2b14c8 docfix: updates docs/settings.rst and docs/faq.rst 2012-11-12 23:44:12 +01:00
jawher
c7d87feec3 Reverted FEED_ATOM and FEED_RSS to their original behaviour and added FEED_ALL_ATOM and FEED_ALL_RSS
FEED_(ATOM|RSS) generated feeds include the version in the default language of a translated article,
whereas FEED_ALL(ATOM|RSS) would include *really* all posts, regardless of their language.
2012-11-12 23:01:16 +01:00
Simon
4c15ec9f86 Move webassets doc to the plugins page 2012-11-07 00:18:00 +01:00
Simon
5f51cffe08 update docs: remove mentions of lesscss compiling and replace with webassets 2012-11-05 21:51:27 +01:00
Alexis Métaireau
ac85e9c819 Merge branch 'pr/223' 2012-10-30 11:18:24 +01:00
Bruno Binet
54eee3f28a update TemplatePagesGenerator:
* bugfix: now supports custom path for path where to find the content files
* TEMPLATE_PAGES settings is now of the form:
    { 'jinja2/src/file.html': 'dest/file.html' }
* update doc
2012-10-30 09:56:10 +01:00
Bruno Binet
e0e1b3eecf rename STATIC_PAGES to TEMPLATE_PAGES 2012-10-30 09:56:10 +01:00
Tarek Ziade
083a8cc172 added some doc about STATIC_PAGES
Conflicts:
	docs/settings.rst
2012-10-30 09:56:10 +01:00
Alexis Métaireau
84c708b74b Revert "Get HtmlReader to work again"
This reverts commit 39db9ddcfd.

Conflicts:

	tests/test_readers.py
2012-10-29 00:36:42 +01:00
Alexis Métaireau
4349a5e815 Update settings documentation. Fix #562 2012-10-28 23:52:16 +01:00
Alexis Métaireau
92d8208309 Merge branch 'master' of github.com:getpelican/pelican 2012-10-28 23:50:49 +01:00
Martin Brochhaus
47c972e21a Added USE_FOLDER_AS_CATEGORY setting.
This allows users to organize their files in ways where the subfolder name
would not make a good category name (i.e. /2012/09/). Set this to ``False``
and the subfolder will no longer be used as a standard category,
`DEFAULT_CATEGORY` will be used instead.
2012-10-28 20:43:45 +01:00
Alexis Métaireau
0ebba1c4ab merge with master 2012-10-25 14:54:19 +02:00