docs: single-page RTFD outline

* Addresses reanahub/reana#335.
reanahub · Jul 28, 2020 · 5e212dd · 5e212dd
1 parent 9bf44e1
commit 5e212dd
Show file tree

Hide file tree

Showing 12 changed files with 48 additions and 66 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,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".
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-Workflow-Engine-Yadage
-==============================
+############################
+REANA-Workflow-Engine-Yadage
+############################
 
 .. image:: https://img.shields.io/travis/reanahub/reana-workflow-engine-yadage.svg
       :target: https://travis-ci.org/reanahub/reana-workflow-engine-yadage
@@ -21,27 +21,34 @@
     :target: https://github.com/psf/black
 
 About
------
+=====
 
 REANA-Workflow-Engine-Yadage is a component of the `REANA
 <http://www.reana.io/>`_ reusable and reproducible research data analysis
 platform. It takes care of instantiating, executing and managing `Yadage
 <https://github.com/diana-hep/yadage>`_ based computational workflows.
 
 Features
---------
+========
 
 - start Yadage workflows
 - control workflow steps
 
+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-workflow-engine-yadage.readthedocs.io/>`_
-- `releases <https://github.com/reanahub/reana-workflow-engine-yadage/releases>`_
-- `known issues <https://github.com/reanahub/reana-workflow-engine-yadage/issues>`_
-- `source code <https://github.com/reanahub/reana-workflow-engine-yadage>`_
+- `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-Workflow-Engine-Yadage releases <https://reana-workflow-engine-yadage.readthedocs.io/en/latest#changes>`_
+- `REANA-Workflow-Engine-Yadage docker images <https://hub.docker.com/r/reanahub/reana-workflow-engine-yadage>`_
+- `REANA-Workflow-Engine-Yadage developer documentation <https://reana-workflow-engine-yadage.readthedocs.io/>`_
+- `REANA-Workflow-Engine-Yadage known issues <https://github.com/reanahub/reana-workflow-engine-yadage/issues>`_
+- `REANA-Workflow-Engine-Yadage source code <https://github.com/reanahub/reana-workflow-engine-yadage>`_
diff --git a/docs/_static/logo-reana.png b/docs/_static/logo-reana.png
diff --git a/docs/authors.rst b/docs/authors.rst
diff --git a/docs/changes.rst b/docs/changes.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -62,7 +62,7 @@
 
 # General information about the project.
 project = "reana"
-copyright = "2017-2019, info@reana.io"
+copyright = "2017-2020, info@reana.io"
 author = "info@reana.io"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -111,7 +111,6 @@
 # documentation.
 #
 html_theme_options = {
-    "logo": "logo-reana.png",
     "description": """<p>REANA-Workflow-Engine-Yadage 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
@@ -2,14 +2,26 @@
    :end-before: About
 
 .. include:: ../README.rst
-   :start-after: -----
+   :start-after: =====
    :end-before: Features
 
-.. toctree::
-   :numbered:
+Features:
 
-   introduction
-   contributing
-   changes
-   license
-   authors
+.. include:: ../README.rst
+   :start-line: 33
+   :end-before: Useful links
+
+.. 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
diff --git a/setup.py b/setup.py
@@ -24,7 +24,7 @@
 
 extras_require = {
     "debug": ["wdb", "ipdb", "Flask-DebugToolbar",],
-    "docs": ["Sphinx>=1.4.4", "sphinx-rtd-theme>=0.1.9",],
+    "docs": ["Sphinx>=1.5.1", "sphinx-rtd-theme>=0.1.9",],
     "tests": tests_require,
 }