Commit graph

1,074 commits

Author SHA1 Message Date
botpub
3c69dc68d2 Release Pelican 4.12.0 2026-04-20 15:29:45 +00:00
Justin Mayer
46ab131940
Merge pull request #3549 from getpelican/install-docs
docs: Add Pipx & `uv` as alternate install methods
2026-04-15 10:44:48 +02:00
Justin Mayer
8ad4e90170 docs: Overhaul installation instructions; add uv 2026-04-15 10:38:00 +02:00
Sam Bull
691995c142
Support CSS_FILE in Simple theme 2026-04-14 12:05:32 +02:00
MinchinWeb
763bf5224c Docs/Settings: update code formatting
to bring it more inline with current black/ruff formatting, particularly in the use of double (over single) quotes
2026-04-13 18:38:03 +02:00
MinchinWeb
d15460c060 Docs/Settings: more notes on how to extract metadata from filenames 2026-04-13 18:38:03 +02:00
MinchinWeb
ebfbc344df Docs/Plugins: document another signal 2026-04-13 18:38:03 +02:00
MinchinWeb
24350502c7 Docs: note that plugins and themes can be found on PyPI 2026-04-13 18:38:03 +02:00
Justin Mayer
74feb7c48b refactor: Upgrade code for Python 3.11 and above 2026-03-31 14:18:33 +02:00
GeorgeHu
b5e20d7f6d
docs: Update Chinese translation (#3559) 2026-02-03 12:11:45 +01:00
Chad Smith
302f20a628 add pipx installation instructions and prefer venv 2025-12-26 22:03:57 +01:00
Sean Hammond
993d21401f Add theme-checkout option to GitHub Pages workflow 2025-12-01 09:24:11 +01:00
Justin Mayer
24e0894840 docs: Avoid using colons in metadata field names
Fix #3486
2025-10-17 09:40:25 +02:00
joelsvensson
af8e861d39
ci: Add Stork install option to GitHub Pages workflow (#3452) 2025-10-16 09:17:39 +02:00
Justin Mayer
b1b06d73a0 Indent custom Furo template to mollify djLint 2025-10-16 09:02:37 +02:00
Justin Mayer
c16417fe99 Update Furo doc theme to version 2025.9.25 2025-10-16 08:49:34 +02:00
Ilya Simpson
595713b91a Fix default FEED_DOMAIN: None -> SITEURL.
This is similar to how `AUTHOR_REGEX_SUBSTITUTIONS` is described, for
instance.
2025-07-21 20:22:27 +02:00
GeorgeHu6
f92b2a27ab Doc: update Chinese translation 2025-07-13 16:40:13 +08:00
Justin Mayer
95965459f2 docs: Fix linter errors with invoke lint --fix 2025-07-09 09:15:40 +02:00
Justin Mayer
f4ee3b7946
Merge pull request #3483 from boxydog/ruff_0_12_2 2025-07-08 08:10:18 +02:00
boxydog
4dedf17958 Move ruff to 0.12.2 and fix new complaints 2025-07-05 10:09:08 -05:00
Justin Mayer
bfd1068b82
Merge pull request #3474 from clockback/use-lists-not-tuples 2025-07-05 07:48:57 +02:00
Ilya Simpson
fca2fde2ed Change lists, not tuples, in config settings
In the documentation, both `SOCIAL` and `LINKS` are described as a list
of tuples, but all examples show them as tuples of tuples. It makes the
most sense for them to be lists, so the examples should match the docs
going forward.

Similarly, `LOCALE` is described as a list, but the examples show it as
a tuple. Likewise, the examples should be lists, in line with the
description.
2025-07-04 20:06:44 +12:00
Ilya Simpson
b2ac0e93aa Fixing default SLUG_REGEX_SUBSTITUTIONS in docs.
Backslashes should not have been doubled, given the defaults are raw
strings.
2025-06-07 22:12:46 +12:00
Ilya Simpson
f44ec52427 Enable flake8-builtins Ruff rule. 2025-06-02 17:22:50 +12:00
Ilya Simpson
ffe22e3c59 Fixing documented default for ARTICLE_SAVE_AS. 2025-05-29 22:29:33 +12:00
Kristinita
7fd66d8a95
docs: Use raw string for the PATH_METADATA setting 2025-04-19 11:00:42 +03:00
Al Sweigart
9c7749a298
docs: Move default values to fix settings anchor links (#3458)
* Fix anchor links for settings by moving default value text down.
* Fix typos in default values.

---------

Co-authored-by: Justin Mayer <entroP@gmail.com>
2025-04-12 12:38:30 +02:00
Víctor Manuel Jáquez Leal
b71159a11e docs: Update install from sources using setuptools 2025-01-27 06:18:55 +01:00
botpub
69e24fa82f Release Pelican 4.11.0 2025-01-15 17:01:09 +00:00
Yashas Lokesh
543424aa41
fix: Fix auto-reload with globs in IGNORE_FILES (#3441)
The default `IGNORE_FILES` value of `'.*'` was being compiled to a regular expression and then passed into `watchfiles.DefaultFilter` to filter out files when auto-reload is enabled.

This commit compares the patterns from `IGNORE_FILES` directly with the filename to match the usage of `fnmatch` elsewhere in the codebase. The new filtering class will continue working as expected for custom `IGNORE_FILES` settings.
2025-01-15 17:40:27 +01:00
Vincent Cheng
5be013d9d2
Make build reproducible by reading envvar SOURCE_DATE_EPOCH if set (#3430)
Co-authored-by: Justin Mayer <entroP@gmail.com>
2025-01-15 17:36:52 +01:00
Alvin Mites
4878fc82a7
chore: Update link to re-directed example settings file (#3445) 2025-01-15 11:43:52 +01:00
Justin Mayer
8a1c55ed07 docs: Clarify namespace plugin loading order 2025-01-14 12:49:34 +01:00
David Lesieur
9207e1ff62
feat: Add setting to omit selected Typogrify filters. Fixes #3436 (#3439) 2025-01-14 12:48:39 +01:00
botpub
07c7eacab9 Release Pelican 4.10.2
Some checks failed
build / Test - 3.10 - macos (push) Has been cancelled
build / Test - 3.11 - macos (push) Has been cancelled
build / Test - 3.12 - macos (push) Has been cancelled
build / Test - 3.10 - ubuntu (push) Has been cancelled
build / Test - 3.11 - ubuntu (push) Has been cancelled
build / Test - 3.12 - ubuntu (push) Has been cancelled
build / Test - 3.8 - ubuntu (push) Has been cancelled
build / Test - 3.9 - ubuntu (push) Has been cancelled
build / Test - 3.10 - windows (push) Has been cancelled
build / Test - 3.11 - windows (push) Has been cancelled
build / Test - 3.12 - windows (push) Has been cancelled
build / Lint (push) Has been cancelled
build / Test build (push) Has been cancelled
build / Build docs (push) Has been cancelled
build / Deploy (push) Has been cancelled
2024-11-27 19:53:23 +00:00
Angus Gratton
1edca55253 settings: Change the default IGNORE_FILES to all "hidden" files.
This is to avoid subtle behaviour that contributed to root cause of
https://github.com/pelican-plugins/sitemap/issues/36

Specifically: if installing Pelican into a local virtualenv with the pdm or uv
default name ".venv", then subdirectories of .venv will contain all of the test
.rst and .md files.

If you then run Pelican in that same root directory using the default PATH
value (".") then it will add those content files to the site.
2024-11-10 12:05:02 +11:00
GeorgeHu6
60261b8c99 Doc: update Chinese translation 2024-11-07 16:31:32 +08:00
Noel Miller
0da2530d9b
De-couple build workflow from GitHub Pages publication (#3404)
Some checks failed
build / Test - 3.10 - macos (push) Has been cancelled
build / Test - 3.11 - macos (push) Has been cancelled
build / Test - 3.12 - macos (push) Has been cancelled
build / Test - 3.10 - ubuntu (push) Has been cancelled
build / Test - 3.11 - ubuntu (push) Has been cancelled
build / Test - 3.12 - ubuntu (push) Has been cancelled
build / Test - 3.8 - ubuntu (push) Has been cancelled
build / Test - 3.9 - ubuntu (push) Has been cancelled
build / Test - 3.10 - windows (push) Has been cancelled
build / Test - 3.11 - windows (push) Has been cancelled
build / Test - 3.12 - windows (push) Has been cancelled
build / Lint (push) Has been cancelled
build / Test build (push) Has been cancelled
build / Build docs (push) Has been cancelled
build / Deploy (push) Has been cancelled
2024-10-22 09:59:19 -07:00
Frederik Elwert
92050d90bc Add FAQ regarding theme overrides
Currently, the documentation refers to creating new themes a lot.
It is much less apparent how one can customize an existing theme by
overriding individual templates or adding new ones. This commit adds
an FAQ for this, and also mentions the mechanism in the FAQ on custom
templates.
2024-10-10 14:35:07 +02:00
botpub
b86383fb28 Release Pelican 4.10.1 2024-09-28 17:02:04 +00:00
botpub
a5db130e1d Release Pelican 4.10.0 2024-09-16 13:23:38 +00:00
GeorgeHu
e609b4d78a
Translate documentation into Simplified Chinese (#3346) 2024-09-15 14:29:01 +02:00
GiovanH
4201256a5b
Add disabled status for #3304 (#3305) 2024-09-12 13:28:51 +02:00
Justin Mayer
bb0ed26fdd Document how to have same source & output hierarchy 2024-07-30 10:00:36 +02:00
Agathe
513abbfdc6
Introduce paragraph count summary (#2761)
Co-authored-by: Justin Mayer <entroP@gmail.com>
2024-06-25 15:07:41 +02:00
Justin Mayer
36ebe91af7 Rename default branch to main 2024-06-25 11:33:28 +02:00
Justin Mayer
49723e6daf Docs: Remove ifconfig Sphinx extension
Originally added in #815, something about this seems to be causing an
obscure ReadTheDocs build error.
2024-06-18 09:08:45 +02:00
Justin Mayer
7a2c72e604
Merge pull request #3337 from getpelican/document-feed-domain-optional 2024-06-17 22:22:59 +02:00
Justin Mayer
05535c7d6c Docs: GitHub Pages workflow is now supported 2024-06-17 22:19:21 +02:00