Add support for hidden versions in the built-in themes; resolves #187

Author: jimporter

CHANGES.md

@@ -5,6 +5,8 @@
 ### New features
 
 - Add support for applying arbitrary properties to documentation versions
+- Add support for hiding specific versions from the selector when using the
+  default themes
 - Deploy aliases using symbolic links by default; this can be configured via
   `--alias-type` on the command line or `alias_type` in the `mike` MkDocs plugin
 - Avoid creating empty commits by default; if you want empty commits, pass

README.md

@@ -248,6 +248,10 @@ is handled.
 Each version of your documentation can have any arbitrary properties assigned to
 it that you like. You can use these properties to hold extra metadata, and then
 your documentation theme can consult those properties to do whatever you like.
+When using the built-in MkDocs themes, mike supports one property: `hidden`.
+When this is `true`, that version will be hidden from the version selector
+(unless it's the current version).
+
 You can get properties via `props` command:
 
 ```sh

mike/themes/mkdocs/js/version-select.js

@@ -34,13 +34,13 @@ window.addEventListener("DOMContentLoaded", function() {
   var ABS_BASE_URL = expandPath(base_url);
   var CURRENT_VERSION = ABS_BASE_URL.match(/\/([^\/]+)\/$/)[1];
 
-  function makeSelect(options, selected) {
+  function makeSelect(options) {
     var select = document.createElement("select");
     select.classList.add("form-control");
 
     options.forEach(function(i) {
       var option = new Option(i.text, i.value, undefined,
-                              i.value === selected);
+                              i.selected);
       select.add(option);
     });
 
@@ -55,9 +55,12 @@ window.addEventListener("DOMContentLoaded", function() {
              i.aliases.includes(CURRENT_VERSION);
     }).version;
 
-    var select = makeSelect(versions.map(function(i) {
-      return {text: i.title, value: i.version};
-    }), realVersion);
+    var select = makeSelect(versions.filter(function(i) {
+      return i.version === realVersion || !i.properties || !i.properties.hidden;
+    }).map(function(i) {
+      return {text: i.title, value: i.version,
+              selected: i.version === realVersion};
+    }));
     select.addEventListener("change", function(event) {
       window.location.href = ABS_BASE_URL + "../" + this.value + "/";
     });

mike/themes/readthedocs/js/version-select.js

@@ -34,12 +34,12 @@ window.addEventListener("DOMContentLoaded", function() {
   var ABS_BASE_URL = expandPath(base_url);
   var CURRENT_VERSION = ABS_BASE_URL.match(/\/([^\/]+)\/$/)[1];
 
-  function makeSelect(options, selected) {
+  function makeSelect(options) {
     var select = document.createElement("select");
 
     options.forEach(function(i) {
       var option = new Option(i.text, i.value, undefined,
-                              i.value === selected);
+                              i.selected);
       select.add(option);
     });
 
@@ -54,9 +54,12 @@ window.addEventListener("DOMContentLoaded", function() {
              i.aliases.includes(CURRENT_VERSION);
     }).version;
 
-    var select = makeSelect(versions.map(function(i) {
-      return {text: i.title, value: i.version};
-    }), realVersion);
+    var select = makeSelect(versions.filter(function(i) {
+      return i.version === realVersion || !i.properties || !i.properties.hidden;
+    }).map(function(i) {
+      return {text: i.title, value: i.version,
+              selected: i.version === realVersion};
+    }));
     select.id = "version-selector";
     select.addEventListener("change", function(event) {
       window.location.href = ABS_BASE_URL + "../" + this.value + "/";