doc: make doc version selector more obvious

Move the doc version selector menu higher on the left nav to make it more visible (from its prior bottom of the nav menu) Signed-off-by: David B. Kinder <[email protected]>
projectacrn · Apr 9, 2019 · cca29cf · cca29cf
1 parent 7745279
commit cca29cf
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 29 deletions.
diff --git a/doc/_templates/aversions.html b/doc/_templates/aversions.html
@@ -0,0 +1,25 @@
+{# Add rst-badge after rst-versions for small badge style. #}
+  <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"> Project ACRN</span>
+      v: {{ current_version }}
+      <span class="fa fa-caret-down"></span>
+    </span>
+    <div class="rst-other-versions">
+      <dl>
+        <dt>{{ _('Document Versions') }}</dt>
+        {% for slug, url in versions %}
+          <dd><a href="{{ url }}">{{ slug }}</a></dd>
+        {% endfor %}
+      </dl>
+      <dl>
+        <dt>{{ _('projectacrn.org links') }}</dt>
+          <dd>
+            <a href="https://www.projectacrn.org/">Project Home</a>
+          </dd>
+          <dd>
+            <a href="https://github.com/projectacrn/acrn-hypervisor/wiki">Wiki</a>
+          </dd>
+      </dl>
+    </div>
+  </div>
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
@@ -0,0 +1,14 @@
+{% extends "!layout.html" %}
+{% block document %}
+  {% if is_release %}
+    <div class="wy-alert wy-alert-danger">
+      The <a href="/{{ pagename }}.html">latest development version</a>
+      of this page may be more current than this released {{ version }} version.
+    </div>
+  {% endif %}
+  {{ super() }}
+{% endblock %}
+{% block menu %}
+  {% include "aversions.html" %}
+  {{ super() }}
+{% endblock %}
diff --git a/doc/_templates/versions.html b/doc/_templates/versions.html
@@ -1,25 +1 @@
-{# Add rst-badge after rst-versions for small badge style. #}
-  <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"> Project ACRN</span>
-      v: {{ current_version }}
-      <span class="fa fa-caret-down"></span>
-    </span>
-    <div class="rst-other-versions">
-      <dl>
-        <dt>{{ _('Versions') }}</dt>
-        {% for slug, url in versions %}
-          <dd><a href="{{ url }}">{{ slug }}</a></dd>
-        {% endfor %}
-      </dl>
-      <dl>
-        <dt>{{ _('On projectacrn.org') }}</dt>
-          <dd>
-            <a href="https://www.projectacrn.org/">Project Home</a>
-          </dd>
-          <dd>
-            <a href="https://github.com/projectacrn/acrn-hypervisor/wiki">Wiki</a>
-          </dd>
-      </dl>
-    </div>
-  </div>
+{# wipe out the versions.html from the rtd theme #}
diff --git a/doc/static/acrn-custom.css b/doc/static/acrn-custom.css
@@ -30,13 +30,10 @@
    font-weight: bold;
 }
 
-/* tweak doc version selection
+/* tweak doc version selection */
 .rst-versions {
    position: static;
-   border-top: none;
-   padding: 0px;
 }
-*/
 
 .rst-versions .rst-current-version {
    padding: 5px;