Doc: setup CI to build the doc

PermafrostDiscoveryGateway · Jul 3, 2020 · e80a146 · e80a146
1 parent 9f20a26
commit e80a146
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -88,3 +88,4 @@ ENV/
 # Rope project settings
 .ropeproject
 .pytest
+public
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -27,3 +27,22 @@ test:python-latest:
 test:python-stretch:
   <<: *job_definition
   image: python:3.7-stretch
+
+#########
+# PAGES #
+#########
+pages:
+  stage: deploy
+  image: python:latest
+  script:
+    - pip install .
+    - pip install .[doc]
+    - sphinx-multiversion docs public
+    - cp -rv docs/index_redirect.html public/index.html
+    - current_version="$(git describe --tags --abbrev=0)"
+    - sed -i "s/VERSION/$current_version/g" public/index.html
+  artifacts:
+    paths:
+      - public
+  only:
+    - master
diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html
@@ -0,0 +1,27 @@
+{%- if current_version %}
+<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    <span class="fa fa-book"> Other Versions</span>
+    v: {{ current_version.name }}
+    <span class="fa fa-caret-down"></span>
+  </span>
+  <div class="rst-other-versions">
+    {%- if versions.tags %}
+    <dl>
+      <dt>Tags</dt>
+      {%- for item in versions.tags %}
+      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+      {%- endfor %}
+    </dl>
+    {%- endif %}
+    {%- if versions.branches %}
+    <dl>
+      <dt>Branches</dt>
+      {%- for item in versions.branches %}
+      <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+      {%- endfor %}
+    </dl>
+    {%- endif %}
+  </div>
+</div>
+{%- endif %}
diff --git a/docs/index_redirect.html b/docs/index_redirect.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Redirecting to VERSION/</title>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; URL=VERSION">
+    <link rel="canonical" href="VERSION/index.html">
+  </head>
+</html>