Merge pull request #4347 from Flamefire/document-maj-ver-template

include major version (`*majver`) templates in auto-generated documentation

Author: boegel

easybuild/framework/easyconfig/templates.py

@@ -77,9 +77,9 @@
     ('installdir', "Installation directory"),
     ('start_dir', "Directory in which the build process begins"),
 ]
-# software names for which to define <pref>ver and <pref>shortver templates
+# software names for which to define <pref>ver, <pref>majver and <pref>shortver templates
 TEMPLATE_SOFTWARE_VERSIONS = [
-    # software name, prefix for *ver and *shortver
+    # software name, prefix for *ver, *majver and *shortver
     ('CUDA', 'cuda'),
     ('CUDAcore', 'cuda'),
     ('Java', 'java'),
@@ -427,6 +427,7 @@ def template_documentation():
     # step 2: add *ver/*shortver templates for software listed in TEMPLATE_SOFTWARE_VERSIONS
     doc.append("Template names/values for (short) software versions")
     for name, pref in TEMPLATE_SOFTWARE_VERSIONS:
+        doc.append("%s%%(%smajver)s: major version for %s" % (indent_l1, pref, name))
         doc.append("%s%%(%sshortver)s: short version for %s (<major>.<minor>)" % (indent_l1, pref, name))
         doc.append("%s%%(%sver)s: full version for %s" % (indent_l1, pref, name))
 

easybuild/tools/docs.py

@@ -440,6 +440,7 @@ def avail_easyconfig_templates_txt():
     # step 2: add SOFTWARE_VERSIONS
     doc.append('Template names/values for (short) software versions')
     for name, pref in TEMPLATE_SOFTWARE_VERSIONS:
+        doc.append("%s%%(%smajver)s: major version for %s" % (INDENT_4SPACES, pref, name))
         doc.append("%s%%(%sshortver)s: short version for %s (<major>.<minor>)" % (INDENT_4SPACES, pref, name))
         doc.append("%s%%(%sver)s: full version for %s" % (INDENT_4SPACES, pref, name))
     doc.append('')
@@ -494,8 +495,10 @@ def avail_easyconfig_templates_rst():
     ver = []
     ver_desc = []
     for name, pref in TEMPLATE_SOFTWARE_VERSIONS:
+        ver.append('``%%(%smajver)s``' % pref)
         ver.append('``%%(%sshortver)s``' % pref)
         ver.append('``%%(%sver)s``' % pref)
+        ver_desc.append('major version for %s' % name)
         ver_desc.append('short version for %s (<major>.<minor>)' % name)
         ver_desc.append('full version for %s' % name)
     table_values = [ver, ver_desc]
@@ -557,8 +560,10 @@ def avail_easyconfig_templates_md():
     ver = []
     ver_desc = []
     for name, pref in TEMPLATE_SOFTWARE_VERSIONS:
+        ver.append('``%%(%smajver)s``' % pref)
         ver.append('``%%(%sshortver)s``' % pref)
         ver.append('``%%(%sver)s``' % pref)
+        ver_desc.append('major version for %s' % name)
         ver_desc.append('short version for %s (``<major>.<minor>``)' % name)
         ver_desc.append('full version for %s' % name)
     table_values = [ver, ver_desc]

test/framework/docs.py

@@ -785,6 +785,7 @@ def test_avail_easyconfig_templates(self):
             r"^Template names/values derived from easyconfig instance",
             r"^\s+%\(version_major\)s: Major version",
             r"^Template names/values for \(short\) software versions",
+            r"^\s+%\(pymajver\)s: major version for Python",
             r"^\s+%\(pyshortver\)s: short version for Python \(<major>\.<minor>\)",
             r"^Template constants that can be used in easyconfigs",
             r"^\s+SOURCE_TAR_GZ: Source \.tar\.gz bundle \(%\(name\)s-%\(version\)s.tar.gz\)",

test/framework/easyconfig.py

@@ -1290,7 +1290,7 @@ def test_templating_doc(self):
         # expected length: 1 per constant and 2 extra per constantgroup (title + empty line in between)
         temps = [
             easyconfig.templates.TEMPLATE_NAMES_EASYCONFIG,
-            easyconfig.templates.TEMPLATE_SOFTWARE_VERSIONS * 2,
+            easyconfig.templates.TEMPLATE_SOFTWARE_VERSIONS * 3,
             easyconfig.templates.TEMPLATE_NAMES_CONFIG,
             easyconfig.templates.TEMPLATE_NAMES_LOWER,
             easyconfig.templates.TEMPLATE_NAMES_EASYBLOCK_RUN_STEP,

test/framework/options.py

@@ -565,6 +565,7 @@ def run_test(fmt=None):
                 pattern_lines = [
                     r'^``%\(version_major\)s``\s+Major version\s*$',
                     r'^``%\(cudaver\)s``\s+full version for CUDA\s*$',
+                    r'^``%\(cudamajver\)s``\s+major version for CUDA\s*$',
                     r'^``%\(pyshortver\)s``\s+short version for Python \(<major>.<minor>\)\s*$',
                     r'^\* ``%\(name\)s``$',
                     r'^``%\(namelower\)s``\s+lower case of value of name\s*$',
@@ -576,6 +577,7 @@ def run_test(fmt=None):
                 pattern_lines = [
                     r'^\s+%\(version_major\)s: Major version$',
                     r'^\s+%\(cudaver\)s: full version for CUDA$',
+                    r'^\s+%\(cudamajver\)s: major version for CUDA$',
                     r'^\s+%\(pyshortver\)s: short version for Python \(<major>.<minor>\)$',
                     r'^\s+%\(name\)s$',
                     r'^\s+%\(namelower\)s: lower case of value of name$',