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.
* Fix anchor links for settings by moving default value text down.
* Fix typos in default values.
---------
Co-authored-by: Justin Mayer <entroP@gmail.com>
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.
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.
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.
Add theme, Python version, siteurl and feed_domain support to the
reusable GitHub Actions workflow for deploying a Pelican site to GitHub
Pages:
1. Add a new `theme` option to the workflow that callers can use to
specify an external theme to be checked out and used
2. Add a new `python` option to the workflow that callers can use to
specify the Python version, in case they need to build their site
with a particular version of Python
3. Pass `--extra-settings FEED_DOMAIN='"${{ steps.pages.outputs.base_url }}"'`
to the `pelican` command to set the value of Pelican's `FEED_DOMAIN`
setting for feed URLs.
4. Add a `feed_domain` input to the workflow so that users can override
the feed domain if they need to.
5. Add a `siteurl` input to the workflow so that users can override the
site URL if they need to.
6. Add a note to the docs about GitHub Pages generating http:// URLs for
https:// sites, and how to fix it
7. Some light editing of the docs for the workflow
