Partly addresses as PoC how we can populate version info in RTD docs …

…using data from a file #36
c3g · Aug 29, 2019 · a16ae3b · a16ae3b
1 parent 47a7b12
commit a16ae3b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/docs/VERSION b/docs/VERSION
@@ -0,0 +1 @@
+3.1.5
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -23,8 +23,13 @@
 copyright = author 
 
 # The full version, including alpha/beta/rc tags
-release = '0.9'
 
+versionfile=open('../VERSION', 'r')
+vstr1=versionfile.read()
+versionfile.close()
+
+version = u'Version '+vstr1
+release = u' '+vstr1+u'( 0.9 draft )' 
 
 # -- General configuration ---------------------------------------------------
 
@@ -63,6 +68,13 @@
 }
 #source_suffix = '.rst'
 
+product_version = vstr1 
+
+rst_epilog = """
+.. |genpipes_version| replace:: %(product_version)s
+""" % { "product_version": product_version ,
+}
+
 master_doc = 'index'
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/source/user_guide/pipelines/gp_rnaseq.rst b/docs/source/user_guide/pipelines/gp_rnaseq.rst
@@ -27,9 +27,8 @@ See :ref:`More Information` section below for details.
 
 Version
 -------
-::
 
-  3.1.4
+|genpipes_version| 
 
 For the latest implementation and usage details refer to RNA Sequencing implementation `README file <https://bitbucket.org/mugqic/genpipes/src/master/pipelines/rnaseq/README.md>`_ file.
 

diff --git a/docs/source/user_guide/pipelines/gp_rnaseq_light.md b/docs/source/user_guide/pipelines/gp_rnaseq_light.md
@@ -25,7 +25,7 @@ RNA Sequencing Light is a lightweight pipeline that performs quick QC and remove
 Version
 -------
 
-TBD
+3.1.4
 
 Usage
 -----
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,9 +27,8 @@ See :ref:`More Information` section below for details. @@
     Version
     -------
-    ::
-.1.4
+    |genpipes_version|
     For the latest implementation and usage details refer to RNA Sequencing implementation `README file <https://bitbucket.org/mugqic/genpipes/src/master/pipelines/rnaseq/README.md>`_ file.
@@ Expand Down @@