From 93b7b9bc79531e80be6b28dbff954bb16d8387f8 Mon Sep 17 00:00:00 2001 From: Tibor Simko Date: Fri, 26 Jan 2018 14:40:43 +0100 Subject: [PATCH] docs: better structure * Enhances documentation structure, updates author list, updates short description and feature list. Signed-off-by: Tibor Simko --- AUTHORS.rst | 3 ++- README.rst | 25 ++++++++++++++++++++++++- docs/authors.rst | 2 ++ docs/changes.rst | 2 ++ docs/conf.py | 4 ++-- docs/contributing.rst | 2 ++ docs/gettingstarted.rst | 4 ---- docs/index.rst | 7 +++++-- docs/introduction.rst | 19 ++++--------------- docs/license.rst | 2 ++ 10 files changed, 45 insertions(+), 25 deletions(-) delete mode 100644 docs/gettingstarted.rst diff --git a/AUTHORS.rst b/AUTHORS.rst index 4a18a9f..4eba61f 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,7 +1,8 @@ Authors ======= +The list of contributors in alphabetical order: + * Diego Rodriguez -* Jiri Kuncar * Lukas Heinrich * Tibor Simko diff --git a/README.rst b/README.rst index 2dc7b62..e15c944 100644 --- a/README.rst +++ b/README.rst @@ -20,4 +20,27 @@ .. image:: https://img.shields.io/github/license/reanahub/reana-workflow-engine-yadage.svg :target: https://github.com/reanahub/reana-workflow-engine-yadage/blob/master/COPYING -The workflow engine yadage component of the REANA system. +About +----- + +REANA-Workflow-Engine-Yadage is a component of the `REANA +`_ reusable analysis platform. It takes care of +instantiating, executing and managing `Yadage +`_ based computational workflows. + +Features +-------- + +- start Yadage workflows +- control workflow steps + +Useful links +------------ + +- `documentation `_ +- `releases `_ +- `known issues `_ +- `source code `_ + +For more information about the REANA reusable analysis platform, please see the +general `REANA documentation `_. diff --git a/docs/authors.rst b/docs/authors.rst index e122f91..a887eee 100644 --- a/docs/authors.rst +++ b/docs/authors.rst @@ -1 +1,3 @@ +.. _authors: + .. include:: ../AUTHORS.rst diff --git a/docs/changes.rst b/docs/changes.rst index d9e113e..58b3592 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -1 +1,3 @@ +.. _changes: + .. include:: ../CHANGES.rst diff --git a/docs/conf.py b/docs/conf.py index 8ce24d8..00fe477 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,7 @@ # General information about the project. project = 'reana' -copyright = '2017, info@reana.io' +copyright = '2017, 2018, info@reana.io' author = 'info@reana.io' # The version info for the project you're documenting, acts as replacement for @@ -112,7 +112,7 @@ # html_theme_options = { 'logo': 'logo-reana.png', - 'description': 'REANA Workflow Engine Yadage', + 'description': 'REANA-Workflow-Engine-Yadage', 'github_user': 'reanahub', 'github_repo': 'reana-workflow-engine-yadage', 'github_button': False, diff --git a/docs/contributing.rst b/docs/contributing.rst index e582053..4628182 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1 +1,3 @@ +.. _contributing: + .. include:: ../CONTRIBUTING.rst diff --git a/docs/gettingstarted.rst b/docs/gettingstarted.rst deleted file mode 100644 index 106ef8e..0000000 --- a/docs/gettingstarted.rst +++ /dev/null @@ -1,4 +0,0 @@ -Getting started -=============== - -FIXME diff --git a/docs/index.rst b/docs/index.rst index a77b790..8bd893f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,14 @@ .. include:: ../README.rst + :end-before: About + +.. include:: ../README.rst + :start-after: ----- + :end-before: Features .. toctree:: :numbered: - :maxdepth: 2 introduction - gettingstarted contributing changes license diff --git a/docs/introduction.rst b/docs/introduction.rst index bf473c7..2757193 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -1,18 +1,7 @@ +.. _introduction: + Introduction ============ -About ------ - -REANA-Workflow-Engine-Yadage is a component of the `REANA -`_ system. It takes care of instantiating and managing -`Yadage `_ workflows. Please see the -`general REANA documentation `_ if you would like -to know more about the use of this component within the wider REANA framework. - -Features --------- - -- start workflows -- control workflow steps -- support for `Yadage `_ workflows +.. include:: ../README.rst + :start-line: 22 diff --git a/docs/license.rst b/docs/license.rst index db18c69..c6ec653 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -1,3 +1,5 @@ +.. _license: + License =======