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

Remove redundant text and reorder settings for consistency

Browse source 
- Remove redundant `YEAR`, `MONTH`, and `DAY` `_ARCHIVE_SAVE_AS` sections
- Move `AUTHOR_URL` and `AUTHOR_SAVE_AS` to match `AUTHOR`, `CATEGORY`, `TAG` order throughout the rest of the document
- Move `YEAR`, `MONTH`, and `DAY` `_ARCHIVE_URL` and `_ARCHIVE_SAVE_AS` sections below paragraph describing them; and match ( `_URL`, `_SAVE_AS` ) order throughout the rest of the document

Recommend viewing with `--diff-algorithm=patience`
This commit is contained in:
Boian Berberov 2019-03-19 20:56:44 -06:00
commit de237e365a
1 changed files with 29 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

82
docs/settings.rst
View file

@ -467,6 +467,14 @@ This would save your articles into something like
The actual location a page draft which doesn't use the default language is The actual location a page draft which doesn't use the default language is
saved at. saved at.
.. data:: AUTHOR_URL = 'author/{slug}.html'
The URL to use for an author.
.. data:: AUTHOR_SAVE_AS = 'author/{slug}.html'
The location to save an author.
.. data:: CATEGORY_URL = 'category/{slug}.html' .. data:: CATEGORY_URL = 'category/{slug}.html'
The URL to use for a category. The URL to use for a category.
@ -483,41 +491,6 @@ This would save your articles into something like
The location to save the tag page. The location to save the tag page.
.. data:: AUTHOR_URL = 'author/{slug}.html'
The URL to use for an author.
.. data:: AUTHOR_SAVE_AS = 'author/{slug}.html'
The location to save an author.
.. data:: YEAR_ARCHIVE_SAVE_AS = ''
The location to save per-year archives of your posts.
.. data:: YEAR_ARCHIVE_URL = ''
The URL to use for per-year archives of your posts. Used only if you have
the ``{url}`` placeholder in ``PAGINATION_PATTERNS``.
.. data:: MONTH_ARCHIVE_SAVE_AS = ''
The location to save per-month archives of your posts.
.. data:: MONTH_ARCHIVE_URL = ''
The URL to use for per-month archives of your posts. Used only if you have
the ``{url}`` placeholder in ``PAGINATION_PATTERNS``.
.. data:: DAY_ARCHIVE_SAVE_AS = ''
The location to save per-day archives of your posts.
.. data:: DAY_ARCHIVE_URL = ''
The URL to use for per-day archives of your posts. Used only if you have the
``{url}`` placeholder in ``PAGINATION_PATTERNS``.
.. note:: .. note::
If you do not want one or more of the default pages to be created (e.g., If you do not want one or more of the default pages to be created (e.g.,
@ -546,6 +519,33 @@ posts for the month at ``posts/2011/Aug/index.html``.
This way a reader can remove a portion of your URL and automatically arrive This way a reader can remove a portion of your URL and automatically arrive
at an appropriate archive of posts, without having to specify a page name. at an appropriate archive of posts, without having to specify a page name.
.. data:: YEAR_ARCHIVE_URL = ''
The URL to use for per-year archives of your posts. Used only if you have
the ``{url}`` placeholder in ``PAGINATION_PATTERNS``.
.. data:: YEAR_ARCHIVE_SAVE_AS = ''
The location to save per-year archives of your posts.
.. data:: MONTH_ARCHIVE_URL = ''
The URL to use for per-month archives of your posts. Used only if you have
the ``{url}`` placeholder in ``PAGINATION_PATTERNS``.
.. data:: MONTH_ARCHIVE_SAVE_AS = ''
The location to save per-month archives of your posts.
.. data:: DAY_ARCHIVE_URL = ''
The URL to use for per-day archives of your posts. Used only if you have the
``{url}`` placeholder in ``PAGINATION_PATTERNS``.
.. data:: DAY_ARCHIVE_SAVE_AS = ''
The location to save per-day archives of your posts.
``DIRECT_TEMPLATES`` work a bit differently than noted above. Only the ``DIRECT_TEMPLATES`` work a bit differently than noted above. Only the
``_SAVE_AS`` settings are available, but it is available for any direct ``_SAVE_AS`` settings are available, but it is available for any direct
template. template.
@ -554,18 +554,6 @@ template.
The location to save the article archives page. The location to save the article archives page.
.. data:: YEAR_ARCHIVE_SAVE_AS = ''
The location to save per-year archives of your posts.
.. data:: MONTH_ARCHIVE_SAVE_AS = ''
The location to save per-month archives of your posts.
.. data:: DAY_ARCHIVE_SAVE_AS = ''
The location to save per-day archives of your posts.
.. data:: AUTHORS_SAVE_AS = 'authors.html' .. data:: AUTHORS_SAVE_AS = 'authors.html'
The location to save the author list. The location to save the author list.