Skip to content

Commit

Permalink
Initial updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
awicenec committed Sep 17, 2020
1 parent dae6406 commit d1579b9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/README.rst
1 change: 1 addition & 0 deletions docs/RELEASE.rst
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import shlex
import subprocess
import sys
from datetime import datetime

read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'

Expand Down Expand Up @@ -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
Expand Down
13 changes: 8 additions & 5 deletions docs/installing.rst
Original file line number Diff line number Diff line change
@@ -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
-------------

Expand Down Expand Up @@ -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.

0 comments on commit d1579b9

Please sign in to comment.