1
0
Fork 0
forked from github/pelican
Commit graph

923 commits

Author SHA1 Message Date
Justin Mayer
f21969a016 Ensure invoke lint task & its docs are in sync
Someday the entire Pelican code base will perhaps have Black and isort
formatting applied to it, but it doesn't make sense for the linter to
check that until it's actually done. This changes the `lint` Invoke task
to run Flake8 on changed lines only, which should bring it into line
with both the current Pre-commit and CI configurations.

Also, the docs erroneously stated that `invoke tests` would also check
for code style compliance, which has herein been fixed.
2020-11-20 16:22:39 +01:00
Justin Mayer
4b79d6dae6 Update PyPI URLs to new equivalents 2020-11-20 15:46:05 +01:00
Justin Mayer
67e27ca7cd pelican-plugins only shows auto-discovered plugins
Document and clarify that only Pip-installed namespace plugins will be
shown when running the `pelican-plugins` command.
2020-11-20 15:39:52 +01:00
Justin Mayer
e3c7a915e5 Fix changelog entry formatting and issue links 2020-11-02 17:18:38 +01:00
botpub
06d4eff4a5 Release Pelican 4.5.1 2020-11-02 13:15:26 +00:00
Justin Mayer
7a6686f467 Fix SUMMARY_END_SUFFIX variable name in changelog 2020-08-29 12:46:44 +02:00
Justin Mayer
4bda2745ac Prepare to release Pelican 4.5 2020-08-20 17:57:21 +02:00
kernc
64fcdb5172
Rename setting SUMMARY_END_MARKER → SUMMARY_END_SUFFIX (#2792)
Avoids clash with 'summary' plugin.

Refs: https://github.com/getpelican/pelican-plugins/pull/1284#issuecomment-660715086
2020-08-19 20:25:19 +02:00
Justin Mayer
145cd4be92 Minor improvements to installation docs 2020-08-17 07:21:57 +02:00
Justin Mayer
a0335711af Remove outdated references to Python 2.7 in docs 2020-08-17 07:14:29 +02:00
Justin Mayer
16975bc3a2 Prefix Pip commands with python -m in docs
This ensures Pip commands will be executed for the current Python
interpreter and not, say, whichever Python interpreter happens to be
associated with `/usr/local/bin/pip`.
2020-08-17 07:04:00 +02:00
Justin Mayer
863421b1b8 Use more reliable installation command in docs
Some shell environments may interpret brackets as glob patterns.
Wrapping the argument in quotation marks should help ensure correct
behavior in those environments. Refs #2786
2020-08-17 06:45:38 +02:00
Justin Mayer
45c5cb9029 Fix error in --extra-settings feature. Refs #2789 2020-08-13 12:07:58 +02:00
Justin Mayer
74692a37a6
Merge pull request #2779 from shakram02/docs-fix-custom-reader-example
fix usage of pelican_open in pelican_internals doc page
2020-08-11 19:12:08 +02:00
Justin Mayer
04c0ea53e6 Document -e / --extra-settings option flags 2020-08-11 12:51:08 +02:00
Justin Mayer
d2bbfd967e Remove self-referential Template Pages link in docs 2020-08-02 10:58:32 +02:00
Justin Mayer
6289452e95 Document inability to control plugin execution order 2020-07-29 06:41:28 +02:00
shakram02
f05a806164
fix usage of pelican_open in docs 2020-07-11 17:39:30 +02:00
magicbrothers
d200c4363c
Fix sentence in docs 2020-06-12 11:24:42 +00:00
Kernc
d6623c642f
Docs: minor fix code block indent 2020-06-05 14:28:11 +02:00
Kernc
20067da9f5
Document how to logging in plugins 2020-06-05 14:24:55 +02:00
Justin Mayer
78edd878a3 Improve namespace plugin documentation 2020-06-04 11:14:37 +02:00
Justin Mayer
9db937e581 Document the pelican-plugins command 2020-05-26 15:18:24 +02:00
Justin Mayer
f0841dc454 Add FAQ entry about Markdown syntax variants 2020-05-17 06:28:04 +02:00
Deniz Turgut
839629b102
Cleanup test environment and requirements
- pytest: verbose isn't needed but show skipped tests
- mock is not needed anymore. it is part of stdlib
- Unpin Sphinx and fix warning about lexer
- Mirror tox command for doc build in tasks.py
2020-05-09 16:17:14 +03:00
Justin Mayer
d43b786b30 Modernize code base to Python 3+ syntax
Replaces syntax that was relevant in earlier Python versions but that
now has modernized equivalents.
2020-04-27 09:45:31 +02:00
Justin Mayer
021ef45f75 Tidy SLUGIFY_* settings documentation 2020-04-21 05:36:28 +02:00
Justin Mayer
7e24886190
Merge pull request #2731 from avaris/unicode-slugify
Add support for Unicode slugs
2020-04-21 05:31:51 +02:00
Deniz Turgut
bd699d34e8 Expose preserve_case option from slugify 2020-04-21 00:26:00 +03:00
Justin Mayer
3b5cdef7f9 Update dev docs to reflect Poetry behavior change
Otherwise, `poetry install` replaces the editable installation with the
current PyPI version.
2020-04-20 09:00:38 +02:00
Deniz Turgut
97fe235e60 Expose use_unicode setting of slugify in settings and use it 2020-04-19 20:21:00 +03:00
fancsali
f610801ee8
Add Typogrify/SmartyPants dashes config parameter (#2615) 2020-04-16 13:32:19 +02:00
Justin Mayer
e18c9d2c60 Remove Piwik from theme and settings docs
Name has been changed, and rather than fix it, it makes more sense to
deprecate analytics in Pelican core and relegate them to plugins/themes.
2020-04-16 08:26:09 +02:00
Justin Mayer
86ff02541f Fix building asciidoc headers in importer & add docs 2020-04-16 08:01:10 +02:00
Cropse
7e52b61934
Enhance JINJA_FILTERS setting docs (#2126) 2020-04-15 10:42:21 +02:00
David Zaslavsky
9eb259af82
Wrong path for attached static content urls (#2158)
* Document _URL/_SAVE_AS path matching req. Fix #2158

This commit addresses the fact that some URLs (primarily {attach}) are based
on the *_SAVE_AS path instead of the *_URL path. It updates the documentation
to point out that the paths of corresponding _URL and _SAVE_AS settings should
match, and that the OUTPUT directory should correspond to the web server's
document root, in order to avoid producing these incorrect URLs.

* Clarify {attach} and *_URL / *_SAVE_AS caveat

Co-authored-by: Justin Mayer <entroP@gmail.com>
2020-04-15 10:35:04 +02:00
Justin Mayer
7d19bcf5d4
Add settings for custom Jinja globals and tests (#2715)
Pelican has a setting for custom Jinja filters but not custom tests or
custom environment namespace globals. This adds both of the latter.
2020-04-12 17:03:53 +02:00
Kurt McKee
7bbd3dc6fb
Update links to HTTPS and current 301 redirects in docs/templates/themes (#2661)
This also updates the Tumblr API to use HTTPS as documented in the
current Tumblr API docs.
2020-04-12 16:38:35 +02:00
Justin Mayer
5b238d189c
Merge pull request #2666 from xuhdev/doc/themes
doc: Add cross links between theme settings and pelican-themes
2020-04-12 08:53:54 +02:00
Justin Mayer
9d8a143ce8
Merge pull request #2660 from kurtmckee/fix-pagination-docs-typo
Fix a typo in the pagination settings docs
2020-04-12 07:17:32 +02:00
Justin Mayer
0fabbb6a60
Merge pull request #2711 from galaxy4public/summary-end-marker
Add custom summary end marker
2020-04-12 06:55:45 +02:00
Justin Mayer
e06934a003 Update documentation copyright & attribution info 2020-04-12 06:07:37 +02:00
(GalaxyMaster)
4833a27243 Provided the settings documentation snippet 2020-04-11 15:42:18 +10:00
Carlos Pereira Atencio
f2dbfbfcec
Docs: Add info about pelican-quickstart command path flag. (#2675) 2020-02-26 19:54:05 +01:00
Justin Mayer
70c8d2a474 Docs: Ensure plugin developers create new branch 2019-12-28 10:20:19 +01:00
Justin Mayer
b8f2326fa6 Document mirroring content & output path hierarchies 2019-12-28 10:02:48 +01:00
Justin Mayer
d7795b8afd Move Python datetime note further down Settings docs 2019-12-28 09:57:41 +01:00
Justin Mayer
d2c857883f Update Python documentation links to Python 3 2019-12-28 09:52:33 +01:00
Justin Mayer
6a9aa1dca8 Remove duplicate datetime URL in Settings docs 2019-12-28 09:48:07 +01:00
Hong Xu
b149a23507 Add cross links between theme settings and pelican-themes 2019-12-25 18:29:45 +08:00