Skip to content

Commit

Permalink
Merge pull request #586 from migueldiascosta/eb411
Browse files Browse the repository at this point in the history
release EasyBuild v4.1.1
  • Loading branch information
boegel authored Jan 16, 2020
2 parents 1b40e63 + 927b56d commit dec172d
Show file tree
Hide file tree
Showing 13 changed files with 1,503 additions and 766 deletions.
6 changes: 4 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
language: python
matrix:
jobs:
include:
- python: "2.7"
- python: "3.6"
- python: "3.8"
# command to install dependencies
install:
- pip install sphinx codespell
- pip install codespell flake8 sphinx
# command to run tests
script:
# it is (currently) impossible to dismiss ignored suggestions but these are
# still added to the exit code (which is a just a count of spelling
# suggestions). Since we know we have one of these, we allow for that.
# see https://github.com/easybuilders/easybuild/pull/485 for details
- codespell --skip=".git,version-specific,scripts" --ignore-words-list=atleast,ninjs,simpy,proovread --quiet-level=2; retVal=$?; if [ $retVal -eq 1 ]; then echo "Got one expected warning, so success!"; else $(exit $retVal); fi;
- flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
- READTHEDOCS=1 sphinx-build docs build
# test installation too (using options that don't require to have a modules tool installed)
- pip install $TRAVIS_BUILD_DIR
Expand Down
1 change: 1 addition & 0 deletions docs/Changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Changelog for EasyBuild documentation

(for EasyBuild release notes, see :ref:`release_notes`)

* **release 20200116.01** (`Jan 16th 2020`): update release notes for EasyBuild v4.1.1 (see :ref:`release_notes_eb411`)
* **release 20191204.01** (`Dec 4th 2019`): update release notes for EasyBuild v4.1.0 (see :ref:`release_notes_eb410`)
* **release 20191015.01** (`Oct 15th 2019`): update release notes for EasyBuild v4.0.1 (see :ref:`release_notes_eb401`)
* **release 20190920.01** (`Sep 20th 2019`): update release notes for EasyBuild v4.0.0 (see :ref:`release_notes_eb400`); see also :ref:`eb4_changes_overview`
Expand Down
1 change: 1 addition & 0 deletions docs/Python-2-3-compatibility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ More specifically, the following Python versions are currently supported:
* Python 3.5.x
* Python 3.6.x
* Python 3.7.x
* Python 3.8.x (requires EasyBuild v4.1.0)

.. _py2_py3_compatibility_EB_VERBOSE:

Expand Down
172 changes: 169 additions & 3 deletions docs/Release_notes.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@
# other places throughout the built documents.
#
# The short X.Y version.
version = '4.1.0' # this is meant to reference the version of EasyBuild
version = '4.1.1' # this is meant to reference the version of EasyBuild
# The full version, including alpha/beta/rc tags.
release = '20191204.0' # this is meant to reference the version of the documentation itself
release = '20200116.0' # 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:
Expand Down
6 changes: 4 additions & 2 deletions docs/scripts/gen_api_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
@author Caroline De Brouwer (Ghent University)
"""
from __future__ import print_function

import os
import subprocess

from vsc.utils.generaloption import simple_option
from easybuild.base.generaloption import simple_option


options = {
Expand All @@ -49,5 +51,5 @@
# -f forces to overwrite existing files
# -e specifies that every module is written in a separate file
cmd = "sphinx-apidoc -o %s %s -f -e" % (so.options.out_folder, so.options.module)
print "$ %s" % cmd
print("$ %s" % cmd)
subprocess.call(cmd, shell=True)
8 changes: 5 additions & 3 deletions docs/scripts/gen_easyblocks_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
@author Caroline De Brouwer (Ghent University)
"""

from __future__ import print_function

import os
import easybuild.tools.config as config

from vsc.utils.generaloption import simple_option
from easybuild.base.generaloption import simple_option
from easybuild.tools.docs import gen_easyblocks_overview_rst
from easybuild.tools.filetools import write_file

Expand Down Expand Up @@ -66,7 +68,7 @@
txt = '\n'.join(autogen_comment + easyblocks_overview)
if so.options.out_file:
write_file(so.options.out_file, txt)
print '%s updated' % so.options.out_file
print('%s updated' % so.options.out_file)
else:
print txt
print(txt)

1,452 changes: 1,005 additions & 447 deletions docs/version-specific/Supported_software.rst

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/version-specific/easyblocks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@
* EB_UFC

* ConfigureMakePythonPackage
* EB_cryptography
* EB_EasyBuildMeta
* EB_EggLib
* EB_libxml2
Expand Down Expand Up @@ -361,6 +362,7 @@
* EB_UFC

* ConfigureMakePythonPackage
* EB_cryptography
* EB_EasyBuildMeta
* EB_EggLib
* EB_libxml2
Expand Down
20 changes: 10 additions & 10 deletions docs/version-specific/easyconfig_parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,16 @@ license parameters
extensions parameters
---------------------

========================== ================================================================================================== =================
**Parameter name** **Description** **Default value**
========================== ================================================================================================== =================
``exts_classmap`` Map of extension name to class for handling build and installation. {}
``exts_default_options`` List of default options for extensions {}
``exts_defaultclass`` List of module for and name of the default extension class None
``exts_download_dep_fail`` Fail if downloaded dependencies are detected for extensions False
``exts_filter`` Extension filter details: template for cmd and input to cmd (templates for name, version and src). None
``exts_list`` List with extensions added to the base installation []
========================== ================================================================================================== =================
========================== ========================================================================================================== =================
**Parameter name** **Description** **Default value**
========================== ========================================================================================================== =================
``exts_classmap`` Map of extension name to class for handling build and installation. {}
``exts_default_options`` List of default options for extensions {}
``exts_defaultclass`` List of module for and name of the default extension class None
``exts_download_dep_fail`` Fail if downloaded dependencies are detected for extensions False
``exts_filter`` Extension filter details: template for cmd and input to cmd (templates for ext_name, ext_version and src). None
``exts_list`` List with extensions added to the base installation []
========================== ========================================================================================================== =================


modules parameters
Expand Down
Loading

0 comments on commit dec172d

Please sign in to comment.