summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* fix theme path constructionOndrej Grover2014-11-052-2/+2
|
* fix special handling of THEMES pathsOndrej Grover2014-11-052-2/+2
|
* support both implicit and explicit inheritance with THEMESOndrej Grover2014-11-052-25/+30
|
* Add Multi-theme supportth3aftermath2014-11-042-3/+26
| | | | | | | Adds multi-theme support using the new THEMES setting. You can specify all the themes that you will be using in python dicionary form. You can then inherit from the themes specified in THEMES using the corresponding key in the dictionary.
* note that {ARTICLE,PAGE}_PATHS may include files, add faq about using thatOndrej Grover2014-11-042-2/+13
|
* advertise the i18n_subsites plugin as an addition to simple translationsOndrej Grover2014-11-041-0/+8
|
* add notices about caching interfering with changes to settings and pluginsOndrej Grover2014-11-034-0/+30
|
* Mention the INDEX_SAVE_AS setting in FAQ and direct templatesOndrej Grover2014-11-032-1/+6
| | | | This setting can be particularly useful when making a static homepage.
* Minor documentation improvementsgw0 [http://gw.tnode.com/]2014-11-022-59/+94
|
* Warn that signal receivers are weakly-referencedTom Most2014-11-021-0/+6
| | | | | | 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.
* Merge pull request #1358 from ingwinlu/md_exten_addJustin Mayer2014-11-021-2/+8
|\ | | | | Improve docs regarding Python-Markdown extensions
| * add paragraph mentioning markdown extensions to docswinlu2014-11-021-2/+8
| |
* | Document Markdown inclusion in Quickstart installJustin Mayer2014-11-021-2/+3
|/
* Merge pull request #1466 from cgar/spellingJustin Mayer2014-11-021-1/+1
|\ | | | | Minor spelling fixes
| * minor spelling fixesCarlos E. Garcia2014-09-152-2/+2
| |
* | Make StaticGenerator skip content sources. Refs #1019.Forest2014-10-311-4/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | Spelling correction in docs: usefull -> useful.Forest2014-10-011-1/+1
| |
* | EXTRA_PATH_METADATA path separator is OS-specifictylerhartley2014-09-301-1/+3
| | | | | | | | | | | | 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.
* | Update faq.rstwinlu2014-09-221-0/+2
| | | | | | 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.
* | Merge pull request #1426 from barrysteyn/DOCUTILS_SETTINGSJustin Mayer2014-09-181-0/+5
|\ \ | | | | | | Documents DOCUTILS_SETTINGS and initializes it. Fixes #1425
| * | Documents DOCUTILS_SETTINGS and initializes it. Fixes #1425Barry Steyn2014-07-311-0/+5
| | |
* | | Merge pull request #1348 from vjousse/davidmarble-page-order-byJustin Mayer2014-09-181-3/+22
|\ \ \ | |_|/ |/| | Support ordering pages and articles when iterating in templates.
| * | Address code review comments from PR getpelican/pelican#1348Mark Lee2014-05-201-15/+21
| | | | | | | | | | | | | | | | | | | | | The text about the sort-by-key function comes from: https://docs.python.org/2/library/stdtypes.html#sequence-types-str-unicode-list-tuple-bytearray-buffer-xrange Minor style cleanup as well.
| * | Merge remote-tracking branch 'remotes/malept/davidmarble-page-order-by' into ↵Vincent Jousse2014-05-141-0/+13
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | davidmarble-page-order-by Conflicts: docs/settings.rst pelican/generators.py pelican/tests/test_generators.py
| | * | Support ordering pages and articles when iterating in templates.David Marble2013-11-141-0/+12
| | | | | | | | | | | | | | | | | | | | Order can be set to a metadata attribute or a sorting function. Default to order by slug for articles and order by filename for pages.
* | | | Merge pull request #1408 from arty-name/feed-writtenJustin Mayer2014-08-281-0/+1
|\ \ \ \ | | | | | | | | | | Add feed_written signal
| * | | | Add feed_written signalArtemy Tregubenko2014-08-281-0/+1
| | | | |
* | | | | Merge pull request #1446 from avaris/enhanced_strftimeJustin Mayer2014-08-281-3/+7
|\ \ \ \ \ | |/ / / / |/| | | | Fixes #1395: extends pelican.utils.strftime with `-` prefix to strip leading zeros
| * | | | Fixes #1395: extends pelican.utils.strftime with `-` prefix to strip leading ↵Deniz Turgut2014-07-161-3/+7
| | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | zeros Adds the ability to use `-` prefix with C89 format codes to strip any leading zeros.
* | | | Merge pull request #1438 from mlissner/patch-2Justin Mayer2014-08-231-1/+1
|\ \ \ \ | | | | | | | | | | Add reference to SLUGIFY_SOURCE
| * | | | Adds reference to SLUGIFY_SOURCEMike Lissner2014-08-161-1/+1
| | | | | | | | | | | | | | | When working on my site, I wanted SLUGIFY_SOURCE, but I came across PATH_METADATA first and enabled that for a while. Better to include the cross-reference where people can find it.
* | | | | Merge pull request #1411 from barrysteyn/typogrify-ignore-listJustin Mayer2014-08-171-0/+3
|\ \ \ \ \ | |/ / / / |/| | | | Allow Typogrify to ignore user specified tags. Refs #1407
| * | | | Allows Typogrify to ignore user specified tags. Refs #1407Barry Steyn2014-07-281-0/+3
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Typogrify interferes with certain sections of the output that it should not touch (see #1407 for more details). This feature adds a setting called TYPOGRIFY_IGNORE_LIST which is a list of tag for Typogrify to ignore. The following was updated: 1. readers.py - if TYPOGRIFY_IGNORE_TAGS is present, then use it 2. settings.ps - default TYPOGRIFY_IGNORE_TAGS to [] 3. contents/article_with_code_block.rst - an article with a code block for typogrify to ignore 4. updated tests 5. updated documentation
* | | | Merge pull request #1412 from avaris/refactor_loggingJustin Mayer2014-08-131-12/+43
|\ \ \ \ | | | | | | | | | | Refactor logging handling
| * | | | Refactor logging handlingDeniz Turgut2014-07-221-12/+43
| |/ / / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Old system was using manual string formatting for log messages. This caused issues with common operations like exception logging because often they need to be handled differently for Py2/Py3 compatibility. In order to unify the effort: - All logging is changed to `logging.level(msg, arg1, arg2)` style. - A `SafeLogger` is implemented to auto-decode exceptions properly in the args (ref #1403). - Custom formatters were overriding useful logging functionality like traceback outputing (ref #1402). They are refactored to be more transparent. Traceback information is provided in `--debug` mode for `read_file` errors in generators. - Formatters will now auto-format multiline log messages in order to make them look related. Similarly, traceback will be formatted in the same fashion. - `pelican.log.LimitFilter` was (ab)using logging message which would result in awkward syntax for argumented logging style. This functionality is moved to `extra` keyword argument. - Levels for errors that would result skipping a file (`read_file`) changed from `warning` to `error` in order to make them stand out among other logs. - Small consistency changes to log messages (i.e. changing all to start with an uppercase letter) and quality-of-life improvements (some log messages were dumping raw object information).
* | | | Corrected typo to improve readabilityCarol Willing2014-07-271-1/+1
|/ / /
* | | removed extra backtick in settings documentationArtemy Tregubenko2014-07-061-1/+1
| | | | | | | | | ``SLUG_SUBSTITUTIONS` = ()`` becomes ``SLUG_SUBSTITUTIONS = ()``
* | | Bump version 3.4.0Justin Mayer2014-07-011-2/+2
| | |
* | | Fix SLUGIFY_SOURCE docsJustin Mayer2014-07-011-2/+2
| | |
* | | Additions to changelogJustin Mayer2014-07-011-1/+4
| | |
* | | Update changelog in preparation for releaseJustin Mayer2014-07-011-4/+18
| | |
* | | Promote URL settings docs to top-level headingJustin Mayer2014-06-301-1/+1
| | |
* | | Add troubleshooting info to CONTRIBUTING docsJustin Mayer2014-06-301-1/+1
| | |
* | | Enhance feedback and contributing guidelinesOndrej Grover2014-06-303-39/+8
| | | | | | | | | | | | | | | | | | | | | | | | Many folks ask for help (via IRC or filing GitHub issues) without sufficient detail and/or without first determining if the answers to their questions might be better sourced elsewhere. These documentation changes encourage users to follow certain guidelines when reaching out for help.
* | | Fix test errors on OSXDeniz Turgut2014-06-261-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | On OSX, if LC_TIME and LC_CTYPE differs the output of strftime is not properly decoded in Python 3. This makes sure that the 'utils.DateFormatter' and the related Jinja filter 'strftime' set the same value for LC_TIME and LC_CTYPE while formatting. Also, '%a' is removed from DEFAULT_DATE_FORMAT in 'custom_locale' tests. OSX and *nix have different conversions for '%a' ('Jeu' vs 'jeu.') and there is not a feasible way to handle the difference for tests.
* | | Fix #1198, enable custom locale in template rendering, fixes linksOndrej Grover2014-06-261-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | reverts getpelican/pelican@ddcccfeaa952d2e1e24ceac94e5d66c73b57c01b If one used a locale that made use of unicode characters (like fr_FR.UTF-8) the files on disk would be in correct locale while links would be to C. Uses a SafeDatetime class that works with unicode format strigns by using custom strftime to prevent ascii decoding errors with Python2. Also added unicode decoding for the calendar module to fix period archives.
* | | Merge pull request #1322 from smartass101/get_files_multiple_pathsJustin Mayer2014-06-252-7/+10
|\ \ \ | | | | | | | | move {ARTICLE,PAGE}_DIR -> {ARTICLE,PAGE}_PATHS and correlate with {ARTICLE,PAGE}_EXCLUDES
| * | | Add {PAGE,ARTICLE}_PATHS to {ARTICLE,PAGE}_EXCLUDES automaticallyOndrej Grover2014-05-141-2/+4
| | | | | | | | | | | | | | | | | | | | This makes it easier for someone to change PAGE_PATHS without the need to change ARTICLE_EXCLUDES accordingly.
| * | | Fix #1344 move PLUGIN_PATH -> PLUGIN_PATHSOndrej Grover2014-05-142-3/+4
| | | | | | | | | | | | | | | | Pelican uses *_PATHS names for settings that represent a list of paths.
| * | | move {ARTICLE,PAGE}_DIR -> {ARTICLE,PAGE}_PATHSOndrej Grover2014-05-141-2/+2
| |/ / | | | | | | | | | | | | | | | | | | 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.