docs: single-page RTFD outline

reanahub · Jul 29, 2020 · cd9045a · cd9045a
1 parent f15e4c7
commit cd9045a
Show file tree

Hide file tree

Showing 14 changed files with 72 additions and 82 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -1,10 +1,7 @@
 Contributing
 ============
 
-Issues
-------
-
-Bug reports, feature requests, and other contributions are welcome. If you find
+Bug reports, issues, feature requests, and other contributions are welcome. If you find
 a demonstrable problem that is caused by the REANA code, please:
 
 1. Search for `already reported problems
@@ -13,11 +10,8 @@ a demonstrable problem that is caused by the REANA code, please:
    latest `master` branch.
 3. Create an issue, ideally with **a test case**.
 
-Pull requests
--------------
-
-If you create a feature branch, you can run the tests to ensure that everything
-is operating correctly:
+If you create a pull request fixing a bug or implementing a feature, you can run
+the tests to ensure that everything is operating correctly:
 
 .. code-block:: console
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2017, 2018 CERN.
+Copyright (C) 2017-2020 CERN.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

diff --git a/README.rst b/README.rst
@@ -1,6 +1,6 @@
-==============
- REANA-Client
-==============
+############
+REANA-Client
+############
 
 .. image:: https://img.shields.io/pypi/pyversions/reana-client.svg
    :target: https://pypi.org/pypi/reana-client
@@ -24,29 +24,45 @@
    :target: https://github.com/psf/black
 
 About
------
+=====
 
 REANA-Client is a component of the `REANA <http://www.reana.io/>`_ reusable and
 reproducible research data analysis platform. It provides a command-line tool
 that allows researchers to submit, run, and manage their computational
 workflows.
 
-Features
---------
-
 - seed workspace with input code and data
 - run computational workflows on remote compute clouds
 - list submitted workflows and enquire about their statuses
 - download results of finished workflows
 
+
+Installation
+============
+
+.. code-block:: console
+
+   $ # create new virtual environment
+   $ virtualenv ~/.virtualenvs/reana
+   $ source ~/.virtualenvs/reana/bin/activate
+   $ # install reana-client
+   $ pip install reana-client
+
+Usage
+=====
+
+The detailed information on how to install and use REANA can be found in
+`docs.reana.io <https://docs.reana.io>`_.
+
+
 Useful links
-------------
+============
 
-- `documentation <https://reana-client.readthedocs.io/>`_
-- `releases <https://github.com/reanahub/reana-client/releases>`_
-- `known issues <https://github.com/reanahub/reana-client/issues>`_
-- `source code <https://github.com/reanahub/reana-client>`_
+- `REANA project home page <http://www.reana.io/>`_
+- `REANA user documentation <https://docs.reana.io>`_
+- `REANA user support forum <https://forum.reana.io>`_
 
-For more information about the REANA reusable analysis platform, please see the
-`REANA project <http://www.reana.io>`_ home page and the general `REANA
-documentation <http://reana.readthedocs.io/>`_ pages.
+- `REANA-Client releases <https://reana-client.readthedocs.io/en/latest#changes>`_
+- `REANA-Client developer documentation <https://reana-client.readthedocs.io/>`_
+- `REANA-Client known issues <https://github.com/reanahub/reana-client/issues>`_
+- `REANA-Client source code <https://github.com/reanahub/reana-client>`_
diff --git a/docs/_static/interactive-session.png b/docs/_static/interactive-session.png
diff --git a/docs/_static/logo-reana.png b/docs/_static/logo-reana.png
diff --git a/docs/apidocs.rst b/docs/apidocs.rst
diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/changes.rst b/docs/changes.rst
diff --git a/docs/cliapi.rst b/docs/cliapi.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -112,7 +112,6 @@
 # documentation.
 #
 html_theme_options = {
-    "logo": "logo-reana.png",
     "description": """<p>REANA-Client is a component of the <a
                       href="http://www.reana.io">REANA</a> reusable and
                       reproducible research data analysis
@@ -130,12 +129,13 @@
         "REANA@Twitter": "https://twitter.com/reanahub",
         "REANA@Web": "http://www.reana.io",
     },
+    "nosidebar": True,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 # Custom sidebar templates, maps document names to template names.
 html_sidebars = {

diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,17 +1,39 @@
+
 .. include:: ../README.rst
    :end-before: About
 
 .. include:: ../README.rst
-   :start-after: -----
-   :end-before: Features
-
-.. toctree::
-   :numbered:
-
-   introduction
-   cliapi
-   apidocs
-   contributing
-   changes
-   license
-   authors
+   :start-after: =====
+   :end-before: Useful links
+
+
+CLI API
+=======
+
+.. include:: cmd_list.txt
+   :literal:
+
+.. click:: reana_client.cli:cli
+   :prog: reana-client
+   :show-nested:
+
+API docs
+========
+
+.. automodule:: reana_client.api.client
+  :members: create_workflow_from_json, upload_file, start_workflow, download_file
+
+.. include:: ../CHANGES.rst
+
+.. include:: ../CONTRIBUTING.rst
+
+License
+=======
+
+.. include:: ../LICENSE
+
+In applying this license, CERN does not waive the privileges and immunities
+granted to it by virtue of its status as an Intergovernmental Organization or
+submit itself to any jurisdiction.
+
+.. include:: ../AUTHORS.rst
diff --git a/docs/introduction.rst b/docs/introduction.rst
diff --git a/docs/license.rst b/docs/license.rst