Merge pull request #2980 from pauloxnet/patch-1

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
 --------------------
@@ -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 <contribute>` **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.
@@ -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`_

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 --------------------------------------------------

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