From 413c6a1c7171ea447bb1817b118d811516283b2e Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Wed, 26 Jan 2022 20:30:03 +0100 Subject: [PATCH 1/4] Order codes in themes.rst --- docs/themes.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/themes.rst b/docs/themes.rst index fe6337d6..db307878 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -34,11 +34,10 @@ Structure To make your own theme, you must follow the following structure:: ├── static - │   ├── css - │   └── images + │ ├── css + │ └── images └── templates ├── archives.html // to display archives - ├── period_archives.html // to display time-period archives ├── article.html // processed for each article ├── author.html // processed for each author ├── authors.html // must list all the authors @@ -46,6 +45,7 @@ To make your own theme, you must follow the following structure:: ├── category.html // processed for each category ├── index.html // the index (list all the articles) ├── page.html // processed for each page + ├── period_archives.html // to display time-period archives ├── tag.html // processed for each tag └── tags.html // must list all the tags. Can be a tag cloud. @@ -465,14 +465,14 @@ The feed variables changed in 3.0. Each variable now explicitly lists ATOM or RSS in the name. ATOM is still the default. Old themes will need to be updated. Here is a complete list of the feed variables:: - FEED_ATOM - FEED_RSS - FEED_ALL_ATOM - FEED_ALL_RSS - CATEGORY_FEED_ATOM - CATEGORY_FEED_RSS AUTHOR_FEED_ATOM AUTHOR_FEED_RSS + CATEGORY_FEED_ATOM + CATEGORY_FEED_RSS + FEED_ALL_ATOM + FEED_ALL_RSS + FEED_ATOM + FEED_RSS TAG_FEED_ATOM TAG_FEED_RSS TRANSLATION_FEED_ATOM From 7acc9ac5546b8b3cc8d9960a34b2eff086740fc9 Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Wed, 26 Jan 2022 20:42:12 +0100 Subject: [PATCH 2/4] Fix documentations errors --- CONTRIBUTING.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7d7b2c3a..59147b31 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -20,7 +20,7 @@ Before you ask for help, please make sure you do the following: you read the docs for the Pelican version you are using. 2. Use a search engine (e.g., DuckDuckGo, Google) to search for a solution to your problem. Someone may have already found a solution, perhaps in the - form of a plugin_ or a specific combination of settings. + form of a ':pelican-doc:`plugins` or a specific combination of settings. 3. Try reproducing the issue in a clean environment, ensuring you are using: @@ -77,7 +77,7 @@ Contributing code Before you submit a contribution, please ask whether it is desired so that you don't spend a lot of time working on something that would be rejected for a known reason. Consider also whether your new feature might be better suited as -a plugin_ — you can `ask for help`_ to make that determination. +a ':pelican-doc:`plugins` — you can `ask for help`_ to make that determination. Using Git and GitHub -------------------- From bf0860ee86874777556d983b996a67b61fd5c5c4 Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Wed, 26 Jan 2022 20:59:02 +0100 Subject: [PATCH 3/4] Try to fix documentation build --- CONTRIBUTING.rst | 4 ++-- docs/conf.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 59147b31..d994bb1d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -132,8 +132,8 @@ Contribution quality standards * Ensure your code is compatible with the `officially-supported Python releases`_. * Add docs and tests for your changes. Undocumented and untested features will not be accepted. -* `Run all the tests`_ **on all versions of Python supported by Pelican** to - ensure nothing was accidentally broken. +* :pelican-doc:`Run all the tests ` **on all versions of Python + supported by Pelican** to ensure nothing was accidentally broken. Check out our `Git Tips`_ page or `ask for help`_ if you need assistance or have any questions about these guidelines. diff --git a/docs/conf.py b/docs/conf.py index 0211c71a..8f80ba63 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ rst_prolog = ''' '''.format(last_stable) extlinks = { - 'pelican-doc': ('https://docs.getpelican.com/%s/', '%s') + 'pelican-doc': ('https://docs.getpelican.com/en/latest/%s.html', '%s') } # -- Options for HTML output -------------------------------------------------- From 5d1dcd8ed3531dda0431db473d0152ea0d476048 Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Wed, 26 Jan 2022 21:03:52 +0100 Subject: [PATCH 4/4] Remove useless url --- CONTRIBUTING.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d994bb1d..c1175aa4 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -141,7 +141,6 @@ need assistance or have any questions about these guidelines. .. _`plugin`: https://docs.getpelican.com/en/latest/plugins.html .. _`Create a new branch`: https://github.com/getpelican/pelican/wiki/Git-Tips#making-your-changes .. _`Squash your commits`: https://github.com/getpelican/pelican/wiki/Git-Tips#squashing-commits -.. _`Run all the tests`: https://docs.getpelican.com/en/latest/contribute.html#running-the-test-suite .. _`Git Tips`: https://github.com/getpelican/pelican/wiki/Git-Tips .. _`PEP8 coding standards`: https://www.python.org/dev/peps/pep-0008/ .. _`ask for help`: `How to get help`_