github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Wrong path for attached static content urls (#2158)

Browse source 
* 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>
This commit is contained in:
David Zaslavsky 2020-04-15 01:35:04 -07:00 • committed by GitHub
commit 9eb259af82
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/content.rst
View file

@ -370,6 +370,10 @@ of ``{attach}``, and letting the file's location be determined by the project's
``STATIC_SAVE_AS`` and ``STATIC_URL`` settings. (Per-file ``save_as`` and ``STATIC_SAVE_AS`` and ``STATIC_URL`` settings. (Per-file ``save_as`` and
``url`` overrides can still be set in ``EXTRA_PATH_METADATA``.) ``url`` overrides can still be set in ``EXTRA_PATH_METADATA``.)
.. note::
When using ``{attach}``, any parent directory in ``*_URL`` / ``*_SAVE_AS``
settings should match each other. See also: :ref:`url-settings`
Linking to authors, categories, index and tags Linking to authors, categories, index and tags
---------------------------------------------- ----------------------------------------------

10
docs/settings.rst
View file

@ -168,7 +168,8 @@ Basic settings
.. data:: OUTPUT_PATH = 'output/' .. data:: OUTPUT_PATH = 'output/'
Where to output the generated files. Where to output the generated files. This should correspond to your web
server's virtual host root directory.
.. data:: PATH .. data:: PATH
@ -358,6 +359,7 @@ Basic settings
The IP to which to bind the HTTP server. The IP to which to bind the HTTP server.
.. _url-settings:
URL settings URL settings
============ ============
@ -378,6 +380,12 @@ variables allow you to place your articles in a location such as
example below). These settings give you the flexibility to place your articles example below). These settings give you the flexibility to place your articles
and pages anywhere you want. and pages anywhere you want.
.. note::
If a ``*_SAVE_AS`` setting contains a parent directory that doesn't match
the parent directory inside the corresponding ``*_URL`` setting, this may
cause Pelican to generate unexpected URLs in a few cases, such as when
using the ``{attach}`` syntax.
If you don't want that flexibility and instead prefer that your generated If you don't want that flexibility and instead prefer that your generated
output paths mirror your source content's filesystem path hierarchy, try the output paths mirror your source content's filesystem path hierarchy, try the
following settings:: following settings::