[docs] Copy development docs to s3 /development

Augustin-Zidek · Apr 5, 2021 · 49a42e2 · 49a42e2
1 parent 9a33bc2
commit 49a42e2
Show file tree

Hide file tree

Showing 4 changed files with 127 additions and 7 deletions.
diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml
@@ -52,12 +52,10 @@ jobs:
     - run: |
         nix-env -f '<nixpkgs>' -iA awscli2
 
-        echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=./$VERSION/index.html\"></head></html>" > index.html
-
-        aws s3 sync html s3://mdtraj/$VERSION
-        aws s3 cp index.html s3://mdtraj
+        aws s3 sync --quiet html s3://mdtraj/development
+        aws s3 cp --quiet root/index.html s3://mdtraj
+        aws s3 cp --quiet root/versions.json s3://mdtraj
       env:
-        VERSION: "1.9.5"
         AWS_DEFAULT_REGION: us-east-1
         AWS_ACCESS_KEY_ID: '${{ secrets.AWS_ACCESS_KEY_ID }}'
         AWS_SECRET_ACCESS_KEY: '${{ secrets.AWS_SECRET_ACCESS_KEY }}'
diff --git a/default.nix b/default.nix
@@ -61,7 +61,6 @@ buildPythonPackage {
     "basesetup.py"
   ];
 
-
   buildInputs = [
     setuptools
     cython
@@ -107,7 +106,8 @@ buildPythonPackage {
   '';
 
   postInstall = ''
-    mkdir -p $out/share/docs
+    mkdir -p $out/share/docs/root
     (cd docs && make html && cp -r _build/html $out/share/docs)
+    cp docs/versions.json docs/index.html $out/share/docs/root/
   '';
 }
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,24 @@
+<html><head>
+<!-- redirect to /development after 3 seconds, in case something fails or
+    the user has javascript disabled -->
+<meta http-equiv="refresh" content="3;URL='/development'"/>
+
+<script type="text/javascript">
+// download the versions.json file and redirect to the URL associated
+// with the entry that has latest=true
+var xhr = new XMLHttpRequest();
+xhr.open('GET', encodeURI('versions.json'));
+xhr.onload = function() {
+    if (xhr.status === 200) {
+        var versions = JSON.parse(xhr.responseText);
+        for (var key in versions) {
+            if (versions[key]['latest']) {
+                var latest = versions[key];
+                window.location.replace(latest['url']);
+            }
+        }
+    }
+}
+xhr.send();
+</script>
+</head></html>
diff --git a/docs/versions.json b/docs/versions.json
@@ -0,0 +1,98 @@
+[
+  {
+    "latest": false,
+    "version": "0.6.1",
+    "display": "0.6",
+    "url": "http://mdtraj.org/0.6.1/index.html"
+  },
+  {
+    "latest": false,
+    "version": "0.7.0",
+    "display": "0.7",
+    "url": "http://mdtraj.org/0.7.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "0.8.0",
+    "display": "0.8",
+    "url": "http://mdtraj.org/0.8.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "0.9.0",
+    "display": "0.9",
+    "url": "http://mdtraj.org/0.9.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.0.0",
+    "display": "1.0",
+    "url": "http://mdtraj.org/1.0.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.1.0",
+    "display": "1.1",
+    "url": "http://mdtraj.org/1.1.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.2.0",
+    "display": "1.2",
+    "url": "http://mdtraj.org/1.2.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.3.0",
+    "display": "1.3",
+    "url": "http://mdtraj.org/1.3.0/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.4.2",
+    "display": "1.4",
+    "url": "http://mdtraj.org/1.4.2/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.6.2",
+    "display": "1.6",
+    "url": "http://mdtraj.org/1.6.2/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.7.2",
+    "display": "1.7",
+    "url": "http://www.mdtraj.org/1.7.2/index.html"
+  },
+  {
+    "latest": false,
+    "version": "1.8.0",
+    "display": "1.8",
+    "url": "http://www.mdtraj.org/1.8.0/index.html"
+  },
+  {
+    "version": "1.9.0",
+    "display": "1.9.0",
+    "url": "http://www.mdtraj.org/1.9.0/index.html",
+    "latest": false
+  },
+  {
+    "version": "1.9.3",
+    "display": "1.9.3",
+    "url": "http://www.mdtraj.org/1.9.3/index.html",
+    "latest": false
+  },
+  {
+    "version": "1.9.4",
+    "display": "1.9.4",
+    "url": "http://www.mdtraj.org/1.9.4/index.html",
+    "latest": false
+  },
+  {
+    "version": "1.9.5",
+    "display": "1.9.5",
+    "url": "http://www.mdtraj.org/1.9.5/index.html",
+    "latest": true
+  }
+]