From d1579b9d0a2ed73de331d9a2e1c66ba8b5ae2417 Mon Sep 17 00:00:00 2001 From: awicenec Date: Thu, 17 Sep 2020 20:56:58 +0800 Subject: [PATCH] Initial updates to documentation --- docs/README.rst | 1 + docs/RELEASE.rst | 1 + docs/conf.py | 3 ++- docs/installing.rst | 13 ++++++++----- 4 files changed, 12 insertions(+), 6 deletions(-) create mode 120000 docs/README.rst create mode 120000 docs/RELEASE.rst diff --git a/docs/README.rst b/docs/README.rst new file mode 120000 index 000000000..89a010694 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file diff --git a/docs/RELEASE.rst b/docs/RELEASE.rst new file mode 120000 index 000000000..42fc36521 --- /dev/null +++ b/docs/RELEASE.rst @@ -0,0 +1 @@ +../RELEASE.rst \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 4188b0162..225e25a14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,6 +16,7 @@ import shlex import subprocess import sys +from datetime import datetime read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' @@ -82,7 +83,7 @@ def __getattr__(cls, _): # General information about the project. project = u'daliuge' -copyright = u'2016, ICRAR' +copyright = u'2016-{0}, ICRAR'.format(datetime.now().year) author = u'ICRAR' # The version info for the project you're documenting, acts as replacement for diff --git a/docs/installing.rst b/docs/installing.rst index 5ce3fbfd9..caa7d4612 100644 --- a/docs/installing.rst +++ b/docs/installing.rst @@ -1,6 +1,14 @@ Installation ============ +Docker images +------------- + +Using Docker is the easiest way to get the DALiuGE system up and running. Docker images for the DALiuGE execution engine and the DALiuGE translator can be built using +the Docker-files under the ``docker`` directories. Please refer to the ``README`` files in the +daliuge_runtime and the daliuge_translator directories for more information. + + Requirements ------------- @@ -52,8 +60,3 @@ There is a known issue in some systems when installing the ``python-daemon`` dependency, which **needs** to be installed via ``pip``. -Docker images -------------- - -Docker images can be built using the Dockerfiles under the ``docker`` directory. -Please refer to the ``README`` file in the docker directory for more information.