Merge pull request #2849 from boegel/generic_easyblocks_docstring

tweak docstring in some generic easyblocks so it renders nicely in auto-generated documentation

Author: branfosj

easybuild/easyblocks/generic/configuremakepythonpackage.py

@@ -36,9 +36,10 @@
 
 class ConfigureMakePythonPackage(ConfigureMake, PythonPackage):
     """
-    Build a Python package and module with 'python configure/make/make install'.
+    Build a Python package and module with ``python configure``/``make``/``make install``.
 
     Implemented by using:
+
     - a custom implementation of configure_step
     - using the build_step and install_step from ConfigureMake
     - using the sanity_check_step and make_module_extra from PythonPackage
@@ -54,21 +55,21 @@ def __init__(self, *args, **kwargs):
         PythonPackage.__init__(self, *args, **kwargs)
 
     def configure_step(self, *args, **kwargs):
-        """Configure build using 'python configure'."""
+        """Configure build using ``python configure``."""
         PythonPackage.configure_step(self, *args, **kwargs)
         cmd = ' '.join([self.cfg['preconfigopts'], self.python_cmd, self.cfg['configopts']])
         run_cmd(cmd, log_all=True)
 
     def build_step(self, *args, **kwargs):
-        """Build Python package with 'make'."""
+        """Build Python package with ``make``."""
         return ConfigureMake.build_step(self, *args, **kwargs)
 
     def test_step(self, *args, **kwargs):
         """Test Python package."""
         PythonPackage.test_step(self, *args, **kwargs)
 
     def install_step(self, *args, **kargs):
-        """Install with 'make install'."""
+        """Install with ``make install``."""
         return ConfigureMake.install_step(self, *args, **kargs)
 
     def sanity_check_step(self, *args, **kwargs):

easybuild/easyblocks/generic/intelbase.py

@@ -91,6 +91,7 @@
 class IntelBase(EasyBlock):
     """
     Base class for Intel software
+
     - no configure/make : binary release
     - add license_file variable
     """

easybuild/easyblocks/generic/rpm.py

@@ -94,6 +94,7 @@ def rebuild_rpm(rpm_path, targetdir):
 class Rpm(Binary):
     """
     Support for installing RPM files.
+
     - sources is a list of rpms
     - installation is with --nodeps (so the sources list has to be complete)
     """

easybuild/easyblocks/generic/tarball.py

@@ -46,8 +46,7 @@
 
 class Tarball(ExtensionEasyBlock):
     """
-    Precompiled software supplied as a tarball:
-    - will unpack binary and copy it to the install dir
+    Precompiled software supplied as a tarball: will unpack binary and copy it to the install dir
     """
 
     @staticmethod