1
0
Fork 0
forked from github/pelican
Commit graph

655 commits

Author SHA1 Message Date
Justin Mayer
ebf5fca520 Merge pull request #1481 from hrbonz/template_context_docs
Add object details to theme docs
2015-03-24 09:57:32 -07:00
robertlagrant
ffe71d324d Change docs wording on cache regen for #1630 2015-03-13 13:42:56 +02:00
Justin Mayer
d53c166f95 Clarify docs for FORMATTED_FIELDS setting 2015-02-25 09:42:33 -08:00
Patrick Fournier
d0afaa5fbe Format custom metadata fields listed in the FORMATTED_FIELDS setting.
Adding FORMATTED_FIELDS to the default settings with ['summary'] as the default value.
2015-02-24 16:57:05 -05:00
pkirk
79aaedc681 rsync -avc, not --avc 2015-02-23 20:13:33 +01:00
Justin Mayer
d4ba7b7291 Correct Dotclear sample file link in importer docs
Fixes #1570
2015-02-18 09:41:27 -08:00
Justin Mayer
bfbb7d4bb5 Merge pull request #1581 from georgevreilly/win-fixes
Fix Pelican rendering and unit tests on Windows.
2015-02-17 17:06:19 -08:00
Justin Mayer
6a69a2c943 Merge pull request #1608 from abackstrom/patch-1
Docs: Note how posts are published when 'draft' is default
2015-02-17 11:21:51 -08:00
Justin Mayer
1301343d1d Merge pull request #1582 from ingwinlu/quickstart_python_python2
DOCS: http server module for python3 is different then python2
2015-02-17 11:11:14 -08:00
Justin Mayer
ca0477c62f Merge pull request #1593 from iKevinY/clarify-setting-types
Change the documented type of various settings
2015-02-17 10:41:07 -08:00
Justin Mayer
9152e021e2 Merge pull request #1616 from kernc/all_generators_finalized
Add signal: all_generators_finalized (see getpelican/pelican-plugins#314)
2015-02-11 10:48:51 -08:00
Kernc
265f68a879 Add signal: all_generators_finalized (getpelican/pelican-plugins#314)
Some plugins have used `content_object_init` signal and read `summary`
or `content` properties of the content object. This resulted in
internal (`{filename}`) links being unresolved. When used, this signal
should hopefully mitigate that.

See also:
* https://github.com/getpelican/pelican-plugins/issues/314
* https://github.com/getpelican/pelican-plugins/pull/410
2015-02-07 16:13:12 +01:00
Matthias Bussonnier
f56b699d5b Fix quotes in faq 2015-02-06 14:30:02 -08:00
Annika Backstrom
4e2e00b450 Docs: Note how posts are published when 'draft' is default 2015-02-01 16:45:26 -05:00
George V. Reilly
4c25610cd8 Fix Pelican rendering and unit tests on Windows.
* Fix {filename} links on Windows.
  Otherwise '{filename}/foo/bar.jpg' doesn't work
* Clean up relative Posix path handling in contents.
* Use Posix paths in readers
* Environment for Popen must be strs, not unicodes.
* Ignore Git CRLF warnings.
* Replace CRLFs with LFs in inputs on Windows.
* Fix importer tests
* Fix test_contents
* Fix one last backslash in paginated output
* Skip the remaining failing locale tests on Windows.
* Document the use of forward slashes on Windows.
* Add some Fabric and ghp-import notes
2015-01-25 17:42:53 -08:00
Kevin Yap
88ad46fd4d Change documented type of various settings
- DEFUALT_METADATA, tuple -> dictionary
- OUTPUT_RETENTION, tuple -> list
- JINJA_FILTERS, list -> dictionary
- DIRECT_TEMPLATES, tuple -> list
2015-01-17 18:15:24 -08:00
Kevin Yap
8aa9a9329e Clarify that 'fs' date setting is a string 2015-01-17 18:15:20 -08:00
Shrayas
bf7966183a Changing dates in copyright information 2015-01-12 09:14:09 +05:30
Shrayas
38c307eefd Add link to GitHub docs on custom 404 pages 2015-01-11 19:18:34 -08:00
Justin Mayer
cff5f3e774 Add custom 404 page to Tips section of docs 2015-01-11 18:54:15 -08:00
winlu
30c4d0eaf3 fix whitespace 2015-01-05 12:22:00 +01:00
winlu
5432dc04a6 fix double definition of simple theme link to different targets 2015-01-05 12:07:01 +01:00
winlu
3763f96011 add comment to 'preview your site' section mentioning the http server module for python3 is different then python 2015-01-05 11:50:48 +01:00
Justin Mayer
2c8300e76f Merge pull request #1537 from omasanori/themes-doc
Add missing feed variables to theme docs
2014-12-06 08:28:28 -08:00
Justin Mayer
3e058dd69c Merge pull request #1539 from rndmh3ro/patch-1
Added documentation for default draft-status of articles
2014-12-06 08:26:50 -08:00
George Angelopoulos
5006dc95d2 docs: fix table formating in importer.rst 2014-11-25 17:38:37 +02:00
Sebastian Gumprich
b3b2e84533 Added documentation for default draft-status of articles 2014-11-18 13:37:27 +00:00
OGINO Masanori
33994f0024 Add missing names in a list of the feed variables.
Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-11-18 19:48:35 +09:00
Justin Mayer
30b8a2069e Merge branch 'master' of github.com:getpelican/pelican 2014-11-04 19:55:21 -08:00
Justin Mayer
3068075963 Update changelog 2014-11-04 19:35:12 -08:00
Kyle Fuller
e302642d06 Merge pull request #1437 from mlissner/patch-1
Updates docs for Python 3
2014-11-04 23:05:48 +00:00
Justin Mayer
7b84e50584 Merge pull request #1516 from foresto/static-attach
Let documents {attach} static files. Fixes #1019.
2014-11-04 14:42:27 -08:00
Forest
d503ea436c Let documents {attach} static files. Fixes #1019.
Until now, making static files end up in the same output directory as an
article that links to them has been difficult, especially when the article's
output path is generated based on metadata. This changeset introduces the
{attach} link syntax, which works like the {filename} syntax, but also
overrides the static file's output path with the directory of the
linking document.

It also clarifies and expands the documentation on linking to internal content.
2014-11-04 12:45:16 -08:00
Ondrej Grover
369b8b8474 note that {ARTICLE,PAGE}_PATHS may include files, add faq about using that 2014-11-04 17:00:01 +01:00
Ondrej Grover
d356b44631 advertise the i18n_subsites plugin as an addition to simple translations 2014-11-04 16:49:03 +01:00
Ondrej Grover
f87e4faa22 add notices about caching interfering with changes to settings and plugins 2014-11-03 21:54:08 +01:00
Ondrej Grover
08044f2436 Mention the INDEX_SAVE_AS setting in FAQ and direct templates
This setting can be particularly useful when making a static homepage.
2014-11-03 20:43:33 +01:00
gw0 [http://gw.tnode.com/]
85f9608ccb Minor documentation improvements 2014-11-02 15:09:25 -08:00
Tom Most
e65d33b89c Warn that signal receivers are weakly-referenced
For the signal get_generators in particular, it may seem natural to use
a lambda or inner function as the signal receiver, but this does not
work as the receiver is collected before it can be called.
2014-11-02 14:39:08 -08:00
Justin Mayer
7d3c765927 Merge pull request #1358 from ingwinlu/md_exten_add
Improve docs regarding Python-Markdown extensions
2014-11-02 14:29:54 -08:00
Justin Mayer
45417832e1 Document Markdown inclusion in Quickstart install 2014-11-02 13:49:31 -08:00
winlu
636f83ab67 add paragraph mentioning markdown extensions to docs 2014-11-02 22:40:44 +01:00
Justin Mayer
de8b437549 Merge pull request #1466 from cgar/spelling
Minor spelling fixes
2014-11-02 12:20:30 -08:00
Forest
48f4f0850d Make StaticGenerator skip content sources. Refs #1019.
This change partially addresses issue #1019, by teaching Pelican to distinguish
between static files and content source files. A user can now safely add the
same directory to both STATIC_PATHS and PAGE_PATHS (or ARTICLE_PATHS). Pelican
will then process the content source files in that directory normally, and
treat the remaining files as static, without copying the raw content source
files to the output directory. (The OUTPUT_SOURCES setting still works.)

In other words, images and markdown/reST files can now safely live together.

To keep those files together in the generated site, STATIC_SAVE_AS and
PAGE_SAVE_AS (or ARTICLE_SAVE_AS) should point to the same output directory.

There are two new configuration settings:

STATIC_EXCLUDES=[]  # This works just like PAGE_EXCLUDES and ARTICLE_EXCLUDES.
STATIC_EXCLUDE_SOURCES=True  # Set this to False to get the old behavior.

Two small but noteworthy internal changes:

StaticGenerator now runs after all the other generators. This allows it to see
which files are meant to be processed by other generators, and avoid them.

Generators now include files that they fail to process (e.g. those with missing
mandatory metadata) along with all the other paths in context['filenames'].
This allows such files to be excluded from StaticGenerator's file list, so they
won't end up accidentally published. Since these files have no Content object,
their value in context['filenames'] is None. The code that uses that dict has
been updated accordingly.
2014-10-31 16:46:01 -07:00
Forest
96eaf9cea0 Spelling correction in docs: usefull -> useful. 2014-10-01 02:05:49 -07:00
tylerhartley
693ad3296c EXTRA_PATH_METADATA path separator is OS-specific
Updating docs for EXTRA_PATH_METADATA to clarify that OS-specific path
separators must be used as keys, unlike some other Pelican variables.
Refs # 1133.
2014-09-30 10:40:26 -07:00
Stefan 'hr' Berder
5e2e88ca92 add objects details to theme docs 2014-09-28 00:33:29 +08:00
winlu
e4a2bb5b52 Update faq.rst
since author feeds are enabled per default http://docs.getpelican.com/en/latest/settings.html#id9 as well, these need to be added here as well.
2014-09-22 16:36:34 +02:00
Justin Mayer
426c7428d6 Merge pull request #1426 from barrysteyn/DOCUTILS_SETTINGS
Documents DOCUTILS_SETTINGS and initializes it. Fixes #1425
2014-09-18 16:17:46 -07:00
Justin Mayer
1d9981b4f9 Merge pull request #1348 from vjousse/davidmarble-page-order-by
Support ordering pages and articles when iterating in templates.
2014-09-18 16:12:51 -07:00