[docs] Show older releases on docs.modm.io

Author: rleh

tools/scripts/docs_modm_io_generator.py

@@ -23,6 +23,7 @@
 from pathlib import Path
 from jinja2 import Environment, FileSystemLoader
 from collections import defaultdict
+import json
 
 def repopath(path):
     return Path(__file__).absolute().parents[2] / path
@@ -112,8 +113,8 @@ def main():
         board_list = [("arduino-nano", "atmega328p-au"), ("arduino-uno", "atmega328p-au"), ("nucleo-g474re", "stm32g474ret6"),
                       ("blue-pill", "stm32f103c8t6"), ("feather-m0", "samd21g18a-uu")]
     elif args.test2:
-        device_list = ["hosted-linux", "atmega328p-pu", "stm32f103zgt7", "stm32g474vet7"]
-        board_list = []
+        device_list = ["hosted-linux", "atmega328p-pu", "stm32f103zgt7"]
+        board_list = [("nucleo-g474re", "stm32g474ret6")]
 
     template_path = os.path.realpath(os.path.dirname(sys.argv[0]))
     cwd = Path().cwd()
@@ -131,7 +132,7 @@ def main():
         os.chdir(tempdir)
         print("Starting to generate documentation...")
         template_overview(output_dir, device_list, board_list, template_path)
-        print("... for {} devices, estimated memory footprint is {} MB".format(len(device_list), (len(device_list)*70)+2000))
+        print("... for {} devices, estimated memory footprint is {} MB".format(len(device_list) + len(board_list), (len(device_list)*70)+2000))
         with multiprocessing.Pool(args.jobs) as pool:
             # We can only pass one argument to pool.map
             devices = ["{}|{}|{}||{}".format(modm_path, tempdir, dev, args.deduplicate) for dev in device_list]
@@ -243,6 +244,12 @@ def template_overview(output_dir, device_list, board_list, template_path):
         num_boards=len(board_list))
     with open(str(output_dir) + "/index.html","w+") as f:
         f.write(html)
+    json_data = {
+        "devices": [str(d).upper() for d in device_list] + [rename_board(b) for (b,_) in board_list],
+        "name2board": [{rename_board(b): b} for (b,_) in board_list],
+    }
+    with open(str(output_dir) + "/develop/targets.json","w+") as outfile:
+        json.dump(json_data, outfile)
     with open(str(output_dir) + "/robots.txt","w+") as f:
         robots_txt = "User-agent: *\n"
         f.write(robots_txt)

tools/scripts/docs_modm_io_index.html.in

@@ -116,18 +116,16 @@ input[type=text] {
 <form autocomplete="off" action="javascript:showDocumentation()">
 <table>
     <tr>
-        <!-- <td>Version/Release</td> -->
+        <td>Version/Release</td>
         <td>Device or Board</td>
         <td>&nbsp;</td>
     </tr>
     <tr>
-        <!--
         <td>
             <select id="releaseinput" name="releases">
                 <option>develop</option>
             </select>
         </td>
-        -->
         <td>
             <div class="autocomplete" style="width:300px;">
                 <input id="targetinput" type="text" name="target" placeholder="Search for e.g. 'F469' or 'NUCLEO'">
@@ -157,6 +155,48 @@ var name2board = {
 "{{ n }}": "{{ b }}",
 {% endfor %}
 };
+
+var possible_releases = ["develop"];
+var current_year = new Date().getFullYear();
+for (var year = 2021; year <= current_year; year++) {
+   possible_releases.push(year + "q1");
+   possible_releases.push(year + "q2");
+   possible_releases.push(year + "q3");
+   possible_releases.push(year + "q4");
+}
+var releases = [];
+possible_releases.forEach(function(r, index, array) {
+    var request = new XMLHttpRequest();
+    request.open("HEAD", "/" + r + "/" + "targets.json", false);
+    request.send();
+    if (request.status == 200) {
+        releases.push(r);
+    }
+});
+var releaseinput = document.getElementById("releaseinput");
+while (releaseinput.options.length) {
+    releaseinput.remove(0);
+}
+for (var i = 0; i < releases.length; i++) {
+    var release = new Option(releases[i]);
+    releaseinput.options.add(release);
+}
+releaseinput.addEventListener("change", function(event) {
+    var url ="/" + releaseinput.value + "/targets.json";
+    var xhr = new XMLHttpRequest();
+    xhr.open('GET', url, true);
+    xhr.responseType = 'json';
+    xhr.onload = function() {
+        if (xhr.status === 200) {
+            devices = xhr.response.devices;
+            name2board = xhr.response.name2board;
+        } else {
+            console.log("Error loading target list for release" + releaseinput.value);
+        }
+    };
+    xhr.send();
+});
+
 var targetinput = document.getElementById("targetinput");
 var currentFocus;
 function showDocumentation() {
@@ -169,7 +209,6 @@ function showDocumentation() {
         }, 5000);
         return;
     }
-    /*
     if(!releaseinput.value) {
         releaseinput.style.transition = "border 5ms ease-out";
         releaseinput.style.borderColor = "red";
@@ -179,10 +218,8 @@ function showDocumentation() {
         }, 5000);
         return;
     }
-    var url = "/" + releaseinput.value + "/api/" + targetinput.value + "/";
-    */
     n2b = name2board[targetinput.value]
-    var url = "/develop/api/" + (n2b ? n2b : targetinput.value).toLowerCase() + "/";
+    var url ="/" + releaseinput.value + "/api/" + (n2b ? n2b : targetinput.value).toLowerCase() + "/";
     location.href = url;
 }
 targetinput.addEventListener("input", function(event) {