doc: Adding the release badges to the install page and the semantic versioning page

This is a part of #528

4 files changed, 65 insertions, 4 deletions

diff --git a/doc/source/install_versions.rst b/doc/source/install_versions.rst
index a82cb9dc7..db0e35d76 100644
--- a/doc/source/install_versions.rst
+++ b/doc/source/install_versions.rst
@@ -13,8 +13,12 @@ For example, for a given version number ``X.Y.Z``
  * The ``X.<odd number>.*`` versions are development spanshots intended for testing.
 
 If you are :ref:`installing from git <install_git_checkout>`, please look for the latest
-tag in the latest release branch to ensure you're getting the latest release.
+tag to ensure you're getting the latest release.
 
-Current release branches:
- * `bst-1.2 (latest) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.2>`_
- * `bst-1.0 (deprecated) <https://gitlab.com/BuildStream/buildstream/commits/bst-1.0>`_
+* Latest release:
+
+  .. include:: release-badge.rst
+
+* Latest development snapshot:
+
+  .. include:: snapshot-badge.rst
diff --git a/doc/source/main_install.rst b/doc/source/main_install.rst
index 80fe497ae..8890fb2cc 100644
--- a/doc/source/main_install.rst
+++ b/doc/source/main_install.rst
@@ -4,6 +4,11 @@
 
 Install
 =======
+
+.. include:: release-badge.rst
+
+.. include:: snapshot-badge.rst
+
 This section provides instructions for installing BuildStream and its
 companion artifact server on various platforms, along with any installation
 related materials.
diff --git a/doc/source/release-badge.rst b/doc/source/release-badge.rst
new file mode 100644
index 000000000..3a09b7f9f
--- /dev/null
+++ b/doc/source/release-badge.rst
@@ -0,0 +1,26 @@
+
+.. Use this file to include the badge in the documentation, but not in
+   the README.rst or gitlab rendered materials, that doesnt work.
+
+   This is partly a workaround for a sphinx issue, we will be able
+   to avoid the raw html once this is implemented in sphinx:
+
+       https://github.com/sphinx-doc/sphinx/issues/2240
+
+   Using the <object> tag instead of the <img> tag which sphinx generates
+   allows the svg to be "interactive", for us this basically means that
+   the link we encode in the badge svg is used, rather than static urls
+   which need to be used around the <img> tag.
+
+   WARNING: The custom CSS on the style tag will need to change if we
+            change the theme, so that the <object> tag behaves similar
+	    to how the <img> tag is themed by the style sheets.
+
+.. raw:: html
+
+   <a class="reference external image-reference">
+     <object style="margin-bottom:24px;vertical-align:middle"
+             data="https://buildstream.gitlab.io/buildstream/_static/release.svg"
+	     type="image/svg+xml"/>
+     </object>
+   </a>
diff --git a/doc/source/snapshot-badge.rst b/doc/source/snapshot-badge.rst
new file mode 100644
index 000000000..b4a3fc9f1
--- /dev/null
+++ b/doc/source/snapshot-badge.rst
@@ -0,0 +1,26 @@
+
+.. Use this file to include the badge in the documentation, but not in
+   the README.rst or gitlab rendered materials, that doesnt work.
+
+   This is partly a workaround for a sphinx issue, we will be able
+   to avoid the raw html once this is implemented in sphinx:
+
+       https://github.com/sphinx-doc/sphinx/issues/2240
+
+   Using the <object> tag instead of the <img> tag which sphinx generates
+   allows the svg to be "interactive", for us this basically means that
+   the link we encode in the badge svg is used, rather than static urls
+   which need to be used around the <img> tag.
+
+   WARNING: The custom CSS on the style tag will need to change if we
+            change the theme, so that the <object> tag behaves similar
+	    to how the <img> tag is themed by the style sheets.
+
+.. raw:: html
+
+   <a class="reference external image-reference">
+     <object style="margin-bottom:24px;vertical-align:middle"
+             data="https://buildstream.gitlab.io/buildstream/_static/snapshot.svg"
+	     type="image/svg+xml"/>
+     </object>
+   </a>