Commit graph

235 commits

Author SHA1 Message Date
Artemy Tregubenko
d35348830a removed extra backtick in settings documentation
``SLUG_SUBSTITUTIONS` = ()`` becomes ``SLUG_SUBSTITUTIONS = ()``
2014-07-06 23:20:19 +02:00
Justin Mayer
09c07e2950 Fix SLUGIFY_SOURCE docs 2014-07-01 13:08:55 -07:00
Justin Mayer
975140d352 Promote URL settings docs to top-level heading 2014-06-30 18:58:14 -07:00
Justin Mayer
2432a22400 Merge pull request #1322 from smartass101/get_files_multiple_paths
move {ARTICLE,PAGE}_DIR -> {ARTICLE,PAGE}_PATHS and correlate with {ARTICLE,PAGE}_EXCLUDES
2014-06-25 07:29:22 -07:00
Deniz Turgut
bf9316bb7e Remove AsciiDocReader from core. Fixes #1355 2014-06-14 02:17:43 -04:00
Ondrej Grover
6aa0e4346d Add {PAGE,ARTICLE}_PATHS to {ARTICLE,PAGE}_EXCLUDES automatically
This makes it easier for someone to change PAGE_PATHS without the
need to change ARTICLE_EXCLUDES accordingly.
2014-05-14 14:30:21 +02:00
Ondrej Grover
21882fd4a0 Fix #1344 move PLUGIN_PATH -> PLUGIN_PATHS
Pelican uses *_PATHS names for settings that represent a list of paths.
2014-05-14 14:19:52 +02:00
Ondrej Grover
d635a347d1 move {ARTICLE,PAGE}_DIR -> {ARTICLE,PAGE}_PATHS
Instead of one path a list can be given. This is due to popular request.
Should help people not wanting to use Pelican for blogging.
Maintain backward compatibility though.
Thanks to @ingwinlu for pointing out the change in StaticGenerator.
2014-05-14 14:04:50 +02:00
Justin Mayer
9d2a129832 If PATH is undefined, Pelican uses PWD as content 2014-05-13 07:18:33 -07:00
Justin Mayer
86e11c619d Split Getting Started docs into separate sections
The "Getting Started" docs became overly long and unwieldy over time.
This splits it into separate sections, including:

* Quickstart
* Installation
* Writing content
* Publish your site
2014-05-12 07:48:37 -07:00
Ondrej Grover
5bad061c19 rename CACHE_DIR -> CACHE_PATH to unify with rest of Pelican
CACHE_PATH can now be relative to settings file like OUTPUT_PATH.
Also add --cache-path commandline option.
Change cache loading warning to a less scary and more helpful message.
2014-05-02 18:08:32 +02:00
Justin Mayer
f2549650e6 Remove errant backtick 2014-05-02 07:34:27 -07:00
Justin Mayer
81cd781c45 Show setting defaults as actual code
For some reason, setting names on the Settings page have long been
wrapped in single back-ticks (usually meant for linking in reST) instead
of double back-ticks (meant for denoting code). This seems to be
widespread throughout the docs, and it's not clear if this is
intentional or simply a reST formatting error that got propagated by
others in order to stay consistent. This commit applies double
back-ticks in any case where something resembling code is shown, with
the idea that single back-ticks should only be used when linking.

More importantly, the settings denoted their default values in
parentheses, which hapless users often included when copying and pasting
these values into their config files. As one can imagine, confusion —
not hilarity — ensued. Setting defaults are now shown as they would
actually appear in one's settings file, with an equal sign and without
parentheses.

During this spelunking expedition, many other minor improvements were
concurrently conducted.
2014-04-30 12:35:13 -07:00
Ondrej Grover
c1324b0206 split content caching into two layers
This is a reworked and improved version of content caching.
Notable changes:
- by default only raw content and metadata returned by readers are
  cached which should prevent conficts with plugins, the speed benefit
  of content objects caching is not very big with a simple setup
- renamed --full-rebuild to --ignore-cache
- added more elaborate logging to caching code
2014-04-20 14:34:52 +02:00
Shauna
e6be02264a Add feeds for each author 2014-04-18 14:29:18 -07:00
Ondrej Grover
6703950abe enable writing of only selected output paths
- add WRITE_SELECTED setting
- add --write-selected commandline option
2014-04-17 19:36:18 +02:00
Justin Mayer
dd70f1b24e Fix settings table in docs 2014-04-15 11:13:10 -04:00
Ondrej Grover
fd77926700 Cache content to speed up reading. Fixes #224.
Cache read content so that it doesn't have to be read next time if its
source has not been modified.
2014-04-15 08:57:38 -04:00
Justin Mayer
7e06912bca Minor text changes to log message limitation 2014-04-14 16:18:07 -04:00
Justin Mayer
b11b8a93cd Merge pull request #1030 from Rogdham/filter_log
Limit and filter logs
2014-04-14 14:56:35 -04:00
Justin Mayer
c6ff88d0fc Minor correction to settings documentation 2014-04-07 14:29:21 -07:00
Rogdham
d9b0091357 Limit and filter logs
Drop duplicates logs.
Allow for logs to be grouped, enforcing a maximum number of logs per group.
Add the LOG_FILTER setting to ask from the configuration file to ignore some
logs (of level up to warning).
2014-04-01 20:44:09 +02:00
Helmut Grohne
3f304a2e92 change the inhibition value of *_SAVE_AS to ''
Previously, the documentation claimed the value of None for this purpose
even though False was used for certain defaults. The values False and
None cause warnings to be emitted from URLWrapper._from_settings though,
so the new way of inhibiting page generation is to set a *_SAVE_AS value
to the empty string.
2014-03-31 19:38:49 +02:00
th3aftermath
01ad449f29 Fix indentation error in the settings doc
This was accidentally caused by me in #1248
As a result the Basic Settings table was not being updated.
2014-03-30 14:35:22 -04:00
th3aftermath
56b0061393 Add the setting SLUGIFY_ATTRIBUTE 2014-03-04 21:16:23 -05:00
Justin Mayer
011cd50e2e Minor improvements to Settings docs 2014-03-01 18:25:07 +01:00
Stefan hr Berder
652eb3686f add lang support for drafts (#826 & #1107)
Fix #826
Fix #1107
2014-02-23 14:03:09 +01:00
Justin Mayer
00e1b68e74 Revert to newly-revived Typogrify project
Since the Typogrify project will be actively maintained going forward,
there is no need for the fork.
2014-02-12 10:54:56 -08:00
Justin Mayer
45e1aa112f Clarify docs re: settings file 2014-02-07 17:05:15 -08:00
Justin Mayer
9dd8e3954c Merge pull request #1202 from tomtung/patch-2
Update settings.rst to match tag cloud code
2014-02-05 07:43:51 -08:00
Simon Conseil
6264cf8916 Clarify docs about the DIRECT_TEMPLATES _SAVE_AS and _URL settings. 2014-01-05 23:37:44 +01:00
Iuri de Silvio
fb1cfc35bf Change CATEGORIES_URL and CATEGORIES_SAVE_AS docs to
make it consistent with TAGS_URL and TAGS_SAVE_AS.

Add default values to CATEGORIES_URL and CATEGORIES_SAVE_AS.
2014-01-05 18:34:23 -02:00
Justin Mayer
505852c04c Use the actively maintained typogrify-web package
The Typogrify library is no longer actively maintained by the
original author. These changes switch Pelican over to a new fork that
will receive more consistent updates going forward.
2014-01-03 08:51:52 -08:00
Tom Yubing Dong
d935af3229 Update settings.rst to match tag cloud code
According to the implementation, the value of `tag.1` should be between 1 and `TAG_CLOUD_STEPS`, inclusive.

See:
https://github.com/getpelican/pelican/blob/master/pelican/generators.py#L457
2013-12-27 15:36:34 +08:00
Mitchell Tannenbaum
add9a0790d Added ARCHIVES_URL to settings.rst 2013-11-22 19:31:09 -05:00
John Cramb
da66245729 Update settings.rst
Added missing CATEGORIES_URL and CATEGORIES_SAVE_AS settings to the table.
2013-11-13 14:15:08 +11:00
Justin Mayer
cb82e48636 None, not False, in *_SAVE_AS docs. Fixes #1106. 2013-10-04 16:23:19 +02:00
Justin Mayer
f6c9237a01 Enhance and correct documentation 2013-09-23 19:30:51 +02:00
SDGSDG
3580233b38 Support for pygment defaults and relevant documentation 2013-09-15 23:13:17 -07:00
Alexis Metaireau
9935286e19 Merge pull request #1056 from bmcorser/fix-utils-copy
Fix for THEME_STATIC_PATHS by copying sensitively
2013-09-09 15:01:13 -07:00
Talha Mansoor
e2236d50d6 Update settings documentation to explain INTRASITE_LINK_REGEX
I have added reference to "Linking to internal content" section because
without it, it is difficult to explain the usage.

I have also updated changelog.

Closes getpelican/pelican#1061
2013-09-09 00:08:39 +05:00
bmcorser
ef16c915d4 Clarification of THEME_STATIC_PATHS behaviour 2013-08-31 21:49:41 +01:00
Daniel Goldsmith
d9816be5de Tag Cloud made functional 2013-08-13 10:46:41 +01:00
Justin Mayer
5a469dc2e3 Merge pull request #1011 from saimn/readers
Refactor readers and remove MARKUP. Fixes #866
2013-08-07 12:34:22 -07:00
Simon Conseil
f47f054d0b Add documentation for readers. 2013-08-07 00:43:49 +02:00
Danilo Bargen
42f9726ffa Support TAGS_* and AUTHORS_* by default. 2013-08-05 19:16:00 +02:00
Justin Mayer
bea03bb4bb Merge pull request #979 from nyergler/pagination_conf
Support flexible pagination configuration
2013-08-03 14:58:47 -07:00
Nathan Yergler
d61ef0c66c Adding basic documentation for PAGINATION_PATTERNS. 2013-08-03 14:06:16 -07:00
Russ Webber
89034f8b3f added THEME_STATIC_DIR setting
The theme static output directory path is now customisable via settings.
i.e. you can now use 'assets' instead of 'theme'.
2013-08-01 11:02:38 +08:00
Kyle Fuller
51dc02f298 Add documentation for WITH_FUTURE_DATES
Closes #952
2013-07-31 23:08:42 +01:00