Reorder URLs to put optional <target> element at the end

projectgus · projectgus · commit 35291f8b7af2 · 2020-03-05T11:42:46.000+11:00
Makes a lot of things simpler
diff --git a/README.rst b/README.rst
@@ -64,15 +64,15 @@ var DOCUMENTATION_VERSIONS = {
 };
 ```
 
-.. note:: This file is JavaScript so it can be easily included in a script tag, but it's excpected to contain a single assignment statement which assigns the ``DOCUMENTATION_VERSIONS`` variable to a valid JSON object. Doing any other JavaScript computation in this file is invalid.
+.. note:: This file is JavaScript so it can be easily included in a script tag, but it's expected to contain a single assignment statement which assigns the ``DOCUMENTATION_VERSIONS`` variable to a valid JSON object. Doing any other JavaScript computation in this file is invalid.
 
 Inside the ``DOCUMENTATION_VERSIONS`` object:
 
 - ``VERSIONS`` key is a list of versions, where each version is a JSON object with at minimum a ``name`` key which is the version name "slug", and optionally one or more of the following keys:
-  - ``has_targets`` is true if the URLs for these docs have a target element, ie ``<project>/<language>/<target>/<version>``. False if the URL format is ``<project>/<language>/<version>``. A single project can have some versions which include and some which exclude the target URL component.
+  - ``has_targets`` is true if the URLs for these docs have a target element, ie ``<project>/<language>/<version>/<target>``. False if the URL format is ``<project>/<language>/<version>``. A single project can have some versions which include and some which exclude the target URL component, and the theme will try to generate version links that add or drop the ``<target>`` element as applicable.
   - ``old`` is true if this version is not current, will be shown in "Old Versions" section under the main versions.
   - ``pre_release`` is true if this version is a prerelease not a stable release, will be shown in "Prereleases" section under  the main versions
-- ``DEFAULTS`` key contains the default values for any keys which are not supplied in an individual ``VERSIONS`` entries. Just exists to make the file more readable.
+- ``DEFAULTS`` key contains the default values for any keys which are not supplied in an individual version object. This exists as "sugar" to make the file more readable.
 
 
 
diff --git a/sphinx_idf_theme/versions.html b/sphinx_idf_theme/versions.html
@@ -9,12 +9,12 @@
     {% if idf_targets %}
       <dl>
         <dt>{{ _('Targets') }}</dt>
-        {% for slug in idf_targets %}
-          {% if slug == idf_target %}
+        {% for target in idf_targets %}
+          {% if target == idf_target %}
             <strong>
           {% endif %}
-            <dd><a href="{{ pathto('../..', 1) }}/{{ slug }}/{{ version }}/{{ pagename }}.html">{{ slug }}</a></dd>
-          {% if slug == idf_target %}
+            <dd><a href="{{ pathto('../..', 1) }}/{{ release }}/{{ target }}/{{ pagename }}.html">{{ target }}</a></dd>
+          {% if target == idf_target %}
             </strong>
           {% endif %}
           {% endfor %}
@@ -23,16 +23,16 @@
     {% if languages %}
       <dl>
         <dt>{{ _('Languages') }}</dt>
-        {% for slug in languages %}
-          {% if slug == language %}
+        {% for language in languages %}
+          {% if language == language %}
             <strong>
               {% endif %}
               {% if idf_targets %}
-              <dd><a href="{{ pathto('../../..', 1) }}/{{ slug }}/{{ idf_target }}/{{ version }}/{{ pagename }}.html">{{ slug }}</a></dd>
+              <dd><a href="{{ pathto('../../..', 1) }}/{{ language }}/{{ release }}/{{ idf_target }}/{{ pagename }}.html">{{ language }}</a></dd>
               {% else %}
-              <dd><a href="{{ pathto('../..', 1) }}/{{ slug }}/{{ version }}/{{ pagename }}.html">{{ slug }}</a></dd>
+              <dd><a href="{{ pathto('../..', 1) }}/{{ language }}/{{ release }}/{{ pagename }}.html">{{ language }}</a></dd>
               {% endif %}
-          {% if slug == language %}
+          {% if language == language %}
             </strong>
           {% endif %}
         {% endfor %}
@@ -45,14 +45,22 @@
       {% endif %}
       <!-- Latest version URL may not be correct depending on whether that version has idf_target as part of the URL format compared to this version.
            JavaScript will update it on page load -->
+      {% if idf_targets %}
+      <dd id="version-latest"><a href="{{ pathto('../..', 1) }}/latest/{{ idf_target }}/{{ pagename }}.html">latest</a></dd>
+      {% else %}
       <dd id="version-latest"><a href="{{ pathto('..', 1) }}/latest/{{ pagename }}.html">latest</a></dd>
+      {% endif %}
       {% if release == "latest" %}
         </strong>
       {% endif %}
 
       <!-- Stable version URL may not be correct depending on whether that version has idf_target as part of the URL format compared to this version.
            JavaScript will update it on page load -->
+      {% if idf_targets %}
+      <dd id="version-stable"><a href="{{ pathto('../..', 1) }}/stable/{{ idf_target }}/{{ pagename }}.html">stable</a></dd>
+      {% else %}
       <dd id="version-stable"><a href="{{ pathto('..', 1) }}/stable/{{ pagename }}.html">stable</a></dd>
+      {% endif %}
     </dl>
     <dl id="versions-prerelease">
       <dt hidden>{{ _('Prereleases') }}</dt>
diff --git a/src/idf_embeds.js b/src/idf_embeds.js
@@ -24,7 +24,7 @@ function setupVersions() {
         }
 
         /* Find the (relative) base URL for this project, finding a sibling URL will be built as follows:
-           <project_base_url>/<language>/<idf_target>/<version>
+           <project_base_url>/<language>/<version>/<idf_target>
 
            (Where 'idf_target' path element are optional depending on if the project has multiple target support)
          */
@@ -36,11 +36,10 @@ function setupVersions() {
 
         /* Given a version from the list, return the URL to link to it */
         function getVersionUrl(v) {
-            let result = project_base_url + "/" + language;
+            let result = project_base_url + "/" + language + "/" + v.name;
             if (v.has_targets) {
                 result += "/" + (idf_target || "esp32");
             }
-            result += "/" + v.name;
 
             result += "/" + pagename; // add the relative path of this page
 
