Add canonical url link in header

Add canonical url to all pages. Requires upgrade to at least 1.8.0 of
sphinx. Upgraded virualenv on sourceforge to have sphinx 1.8.5 to
allow it to work. Hand patched the files on sourceforge and deployed.

Also added a postprocess step to Makefile needed on sourceforge to
load searchtools.js.

Author: rouilj

website/www/Makefile

@@ -15,9 +15,12 @@ docs:
 	ln -s ../../doc ./docs
 	ln -s ../../COPYING.txt
 
+# after upgrade to sphinx 1.8.5, search.html is missing load of searchtools.
+# fix that in postprocess
 html: docs
 	mkdir -p $(TMP)/doctrees $(HTML)
 	sphinx-build -n -W -b html -d $(TMP)/doctrees . $(HTML)
+	grep 'searchtools.js' html/search.html || sed -i -e '/language_data.js/s#</script>#</script>\n    <script type="text/javascript" src="_static/searchtools.js"></script>#' html/search.html
 
 linkcheck:
 	mkdir -p $(TMP)/linkcheck $(TMP)/doctrees

website/www/_templates/layout.html

@@ -34,6 +34,9 @@
     {%- for scriptfile in script_files %}
     <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
     {%- endfor %}
+    {%- if pageurl %}
+    <link rel="canonical" href="{{ pageurl|e }}" />
+    {%- endif %}
     {%- if use_opensearch %}
     <link rel="search" type="application/opensearchdescription+xml"
           title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"

website/www/conf.py

@@ -106,6 +106,10 @@
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #html_short_title = None
 
+# The base URL which points to the root of the HTML documentation. It is
+# used to indicate the location of document using The Canonical Link Relation.
+html_baseurl = "https://www.roundup-tracker.org/"
+
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #html_logo = None