Merge pull request #109 from hpcugent/develop

update docs to 20150316.01
easybuilders · Mar 19, 2015 · becb015 · becb015
2 parents 59b127a + 07443f7
commit becb015
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/docs/Changelog.rst b/docs/Changelog.rst
@@ -3,6 +3,10 @@
 Changelog for EasyBuild documentation
 -------------------------------------
 
+* **release 20150316.01** (`Mar 16th 2015`):
+
+  * include list of EasyBuild repositories cloned by ``install-EasyBuild-develop.sh`` script
+    (see :ref:`install_latest_develop_using_script`)
 * **release 20150312.01** (`Mar 12th 2015`):
 
   * enhance documentation w.r.t. template values in configuration files (see :ref:`configuration_file_templates_constants`)

diff --git a/docs/Installation_Alternative.rst b/docs/Installation_Alternative.rst
@@ -174,7 +174,24 @@ Installation of latest development version using provided script
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After you have forked each of the EasyBuild repositories on GitHub (+ vsc-base), you can set up a development version
-of EasyBuild, in the following manner::
+of EasyBuild using the ``install-EasyBuild-develop.sh`` script.
+
+This script will clone the different EasyBuild repositories from GitHub:
+
+ * `easybuild <https://github.com/hpcugent/easybuild>`_:
+   EasyBuild metapackage & documentation sources for http://easybuild.readthedocs.org
+ * `vsc-base <https://github.com/hpcugent/vsc-base>`_:
+   dependency for EasyBuild framework (logging, command line interface, ...)
+ * `easybuild-framework <https://github.com/hpcugent/easybuild-framework>`_:
+   EasyBuild framework
+ * `easybuild-easyblocks <https://github.com/hpcugent/easybuild-easyblocks>`_:
+   collection of easyblocks
+ * `easybuild-easyconfigs <https://github.com/hpcugent/easybuild-easyconfigs>`_:
+   collection of easyconfig files
+ * `easybuild-wiki <https://github.com/hpcugent/easybuild-wiki>`_:
+   EasyBuild wiki pages
+
+It can be used as follows::
 
     # pick an installation prefix (adjust as you like)
     INSTALL_PREFIX=$(mktemp -d $HOME/EasyBuild-XXXXXX)

diff --git a/docs/conf.py b/docs/conf.py
@@ -43,7 +43,7 @@
 # The short X.Y version.
 version = '2.0.0'  # this is meant to reference the version of EasyBuild
 # The full version, including alpha/beta/rc tags.
-release = '20150312.01'  # this is meant to reference the version of the documentation itself
+release = '20150316.01'  # this is meant to reference the version of the documentation itself
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used: