From 2f74daa02ac02d63f3f755c36b0749c8f91eb733 Mon Sep 17 00:00:00 2001
From: Clément Pit-Claudel
Date: Fri, 8 May 2020 22:10:58 -0400
Subject: [sphinx] Add links to other versions of the refman

---
 doc/sphinx/_templates/versions.html | 48 +++++++++++++++++++++++++++++++++++++
 doc/sphinx/conf.py                  | 22 ++++++++++++++++-
 2 files changed, 69 insertions(+), 1 deletion(-)
 create mode 100644 doc/sphinx/_templates/versions.html

(limited to 'doc/sphinx')

diff --git a/doc/sphinx/_templates/versions.html b/doc/sphinx/_templates/versions.html
new file mode 100644
index 0000000000..967d00d2bf
--- /dev/null
+++ b/doc/sphinx/_templates/versions.html
@@ -0,0 +1,48 @@
+{# Forked from versions.html in sphinx_rtd_theme 0.4.3 #}
+
+{#
+The MIT License (MIT)
+
+Copyright (c) 2013-2018 Dave Snider, Read the Docs, Inc. & contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#}
+
+{% if not READTHEDOCS %}
+  <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: {{ 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>{{ _('Downloads') }}</dt>
+        {% for type, url in downloads %}
+          <dd><a href="{{ url }}">{{ type }}</a></dd>
+        {% endfor %}
+      </dl>
+    </div>
+  </div>
+{% endif %}
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index dbe582df95..4136b406de 100755
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -202,6 +202,7 @@ html_theme = 'sphinx_rtd_theme'
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
+PDF_URL = "https://github.com/coq/coq/releases/download/V{version}/coq-{version}-reference-manual.pdf"
 html_theme_options = {
     'collapse_navigation': False
 }
@@ -210,7 +211,26 @@ html_context = {
     'github_user': 'coq',
     'github_repo': 'coq',
     'github_version': 'master',
-    'conf_py_path': '/doc/sphinx/'
+    'conf_py_path': '/doc/sphinx/',
+    # Versions and downloads listed in the versions menu (see _templates/versions.html)
+    'versions': [
+        ("master", "https://coq.github.io/doc/master/refman/"),
+        ("stable", "https://coq.inria.fr/distrib/current/refman/"),
+        ("v8.11", "https://coq.github.io/doc/v8.11/refman/"),
+        ("v8.10", "https://coq.github.io/doc/v8.10/refman/"),
+        ("v8.9", "https://coq.github.io/doc/v8.9/refman/"),
+        ("8.8", "https://coq.inria.fr/distrib/V8.8.2/refman/"),
+        ("8.7", "https://coq.inria.fr/distrib/V8.7.2/refman/"),
+        ("8.6", "https://coq.inria.fr/distrib/V8.6.1/refman/"),
+        ("8.5", "https://coq.inria.fr/distrib/V8.5pl3/refman/"),
+        ("8.4", "https://coq.inria.fr/distrib/V8.4pl6/refman/"),
+        ("8.3", "https://coq.inria.fr/distrib/V8.3pl5/refman/"),
+        ("8.2", "https://coq.inria.fr/distrib/V8.2pl3/refman/"),
+        ("8.1", "https://coq.inria.fr/distrib/V8.1pl6/refman/"),
+        ("8.0", "https://coq.inria.fr/distrib/V8.0/doc/")
+    ],
+    'downloads': ([("PDF", PDF_URL.format(version=version))]
+                  if coq_config.is_a_released_version else [])
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
-- 
cgit v1.2.3