Merge 8f9c6f3 into f5ceec7

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,21 +10,11 @@ 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, you can run
+the tests to ensure that everything is operating correctly:
 
 .. code-block:: console
 
     $ ./run-tests.sh
 
 Each pull request should preserve or increase code coverage.
-
-Kanban
-------
-
-We are using Kanban technique for keeping track of ongoing tasks. Please see
-our `Kanban boards <https://github.com/orgs/reanahub/projects>`_ and look for
-issues that are "ready for work".

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (C) 2018 CERN.
+Copyright (C) 2018-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

README.rst

@@ -1,6 +1,6 @@
-==============
- REANA-Commons
-==============
+#############
+REANA-Commons
+#############
 
 .. image:: https://img.shields.io/pypi/pyversions/reana-commons.svg
       :target: https://pypi.org/pypi/reana-commons
@@ -24,28 +24,34 @@
    :target: https://github.com/psf/black
 
 About
------
+=====
 
 REANA-Commons is a component of the `REANA <http://www.reana.io/>`_ reusable and
 reproducible research data analysis platform. It provides common utilities and
 schemas shared by the REANA cluster components.
 
 Features
---------
+========
 
 - common API clients for internal communication
 - centralised OpenAPI specifications for REANA components
 - AMQP connection management and communication
 - utility functions for cluster components
 
+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-commons.readthedocs.io/>`_
-- `releases <https://github.com/reanahub/reana-commons/releases>`_
-- `known issues <https://github.com/reanahub/reana-commons/issues>`_
-- `source code <https://github.com/reanahub/reana-commons>`_
+- `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-Commons releases <https://reana-commons.readthedocs.io/en/latest/changes.html>`_
+- `REANA-Commons developer documentation <https://reana-commons.readthedocs.io/>`_
+- `REANA-Commons known issues <https://github.com/reanahub/reana-commons/issues>`_
+- `REANA-Commons source code <https://github.com/reanahub/reana-commons>`_

docs/conf.py

@@ -61,7 +61,7 @@
 
 # General information about the project.
 project = "reana"
-copyright = "2018, info@reana.io"
+copyright = "2018-2020, info@reana.io"
 author = "info@reana.io"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -128,12 +128,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 = {

docs/index.rst

@@ -2,16 +2,85 @@
    :end-before: About
 
 .. include:: ../README.rst
-   :start-after: -----
+   :start-after: =====
    :end-before: Features
 
-.. toctree::
-   :numbered:
+Features:
 
-   introduction
-   configuration
-   api
-   contributing
-   changes
-   license
-   authors
+.. include:: ../README.rst
+   :start-line: 35
+   :end-before: Useful links
+
+
+Configuration
+=============
+
+.. automodule:: reana_commons.config
+   :members:
+
+API
+===
+
+REANA API client
+----------------
+
+.. automodule:: reana_commons.api_client
+   :members:
+
+REANA Kubernetes API client
+---------------------------
+
+.. automodule:: reana_commons.k8s.api_client
+   :members:
+
+.. automodule:: reana_commons.k8s.volumes
+   :members:
+
+REANA AMQP Publisher
+--------------------
+
+.. automodule:: reana_commons.publisher
+   :members:
+
+
+REANA AMQP Consumer
+--------------------
+
+.. automodule:: reana_commons.consumer
+   :members:
+
+
+REANA Serial workflow utilities
+-------------------------------
+
+.. automodule:: reana_commons.serial
+   :members:
+
+
+REANA utilities
+---------------
+
+.. automodule:: reana_commons.utils
+   :members:
+
+REANA errors
+------------
+
+.. automodule:: reana_commons.errors
+   :members:
+
+
+.. 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