Merge remote-tracking branch 'app4triqs-remote/4.0.x' into 4.0.x

# Conflicts:
#	doc/conf.py.in
#	doc/doxygen/Doxyfile.in

Author: Wentzell

CMakeLists.txt

@@ -27,6 +27,9 @@ cmake_policy(VERSION ${CMAKE_VERSION})
 project(triqs_dft_tools VERSION 4.0.0 LANGUAGES CXX)
 get_directory_property(IS_SUBPROJECT PARENT_DIRECTORY)
 
+# version displayed in the documentation
+set(BRANCH_FOR_DOC ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.x)
+
 # ############
 # Load TRIQS
 find_package(TRIQS 4.0 REQUIRED)

doc/_templates/versions.html

@@ -0,0 +1,25 @@
+{# Version switcher flyout.
+
+   sphinx_rtd_theme 3.x ships an empty versions.html (the flyout is injected by
+   the ReadTheDocs addons when hosted there, and is absent on self-hosted
+   builds). layout.html still does `{% include "versions.html" %}`, so this
+   override revives the classic bottom-left "v: <version> ▾" widget. It is
+   styled by the theme's existing .rst-versions CSS and toggled by theme.js;
+   the entries come from html_context['versions'] in conf.py. #}
+{%- if versions %}
+<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"> {{ _('Versions') }}</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>
+  </div>
+</div>
+{%- endif %}

doc/conf.py.in

@@ -52,7 +52,7 @@ autosummary_generate = True
 autosummary_imported_members = False
 
 project = 'TRIQS DFTTools'
-version = '@PROJECT_VERSION@'
+version = '@BRANCH_FOR_DOC@'
 
 # this makes the current project version available as var in every rst file
 rst_epilog = """
@@ -71,6 +71,12 @@ html_theme = 'sphinx_rtd_theme'
 # this loads the custom css file to change the page width
 html_style = 'css/custom.css'
 
+# Point search engines at the evergreen "latest" build of each page via a
+# rel="canonical" link. Setting this in *every* version build (unstable, X.Y.x,
+# ...) consolidates ranking signals onto the latest/ docs so they are preferred
+# over older versions in search results.
+html_baseurl = 'https://triqs.github.io/@PROJECT_NAME@/latest/'
+
 html_favicon = '@CMAKE_CURRENT_SOURCE_DIR@/_static/triqs_logo/triqs_favicon.ico'
 #html_logo = '@CMAKE_CURRENT_SOURCE_DIR@/logos/logo.png'
 
@@ -92,7 +98,18 @@ html_theme_options = {
 
 html_show_sphinx = False
 
-html_context = {'header_title': 'TRIQS DFTTools'}
+html_context = {
+    'header_title': 'TRIQS DFTTools',
+    # Version switcher flyout (rendered by _templates/versions.html, which
+    # overrides the empty versions.html shipped by sphinx_rtd_theme 3.x). The
+    # list is static -- update it when a new release line is published.
+    'current_version': version,
+    'versions': [
+        ['unstable', 'https://triqs.github.io/@PROJECT_NAME@/unstable/'],
+        ['4.0.x',    'https://triqs.github.io/@PROJECT_NAME@/4.0.x/'],
+        ['3.3.x',    'https://triqs.github.io/@PROJECT_NAME@/3.3.x/'],
+    ],
+}
 
 html_static_path = ['@CMAKE_CURRENT_SOURCE_DIR@/_static']
 html_sidebars = {'index': ['sideb.html', 'searchbox.html']}