docs: single-page RTFD outline

addresses reanahub/reana#335
reanahub · Jul 29, 2020 · f3964a8 · f3964a8
1 parent 8dff8ba
commit f3964a8
Show file tree

Hide file tree

Showing 12 changed files with 59 additions and 81 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 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) 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

diff --git a/README.rst b/README.rst
@@ -1,6 +1,6 @@
-==============
- pytest-REANA
-==============
+############
+pytest-REANA
+############
 
 .. image:: https://img.shields.io/pypi/pyversions/pytest-reana.svg
       :target: https://pypi.org/pypi/pytest-reana
@@ -24,14 +24,14 @@
    :target: https://github.com/psf/black
 
 About
------
+=====
 
 pytest-REANA is a component of the `REANA <http://www.reana.io/>`_ reusable and
 reproducible research data analysis platform. It provides pytest fixtures and
 test utilities.
 
 Features
---------
+========
 
 - pytest fixtures
 - mocking OpenAPI client with request format validation
@@ -41,14 +41,20 @@ Features
 - mocking database access
 - includes sample workspace directory
 
+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://pytest-reana.readthedocs.io/>`_
-- `releases <https://github.com/reanahub/pytest-reana/releases>`_
-- `known issues <https://github.com/reanahub/pytest-reana/issues>`_
-- `source code <https://github.com/reanahub/pytest-reana>`_
+- `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.
+- `pytest-REANA releases <https://pytest-reana.readthedocs.io/en/latest#changes>`_
+- `pytest-REANA developer documentation <https://pytest-reana.readthedocs.io/>`_
+- `pytest-REANA known issues <https://github.com/reanahub/pytest-reana/issues>`_
+- `pytest-REANA source code <https://github.com/reanahub/pytest-reana>`_
diff --git a/docs/_static/logo-reana.png b/docs/_static/logo-reana.png
diff --git a/docs/api.rst b/docs/api.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/conf.py b/docs/conf.py
@@ -55,7 +55,7 @@
 
 # General information about the project.
 project = "reana"
-copyright = "2018-2019, 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
@@ -121,6 +121,7 @@
         "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,

diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,15 +2,40 @@
    :end-before: About
 
 .. include:: ../README.rst
-   :start-after: -----
+   :start-after: =====
    :end-before: Features
 
-.. toctree::
-   :numbered:
+Features:
 
-   introduction
-   api
-   contributing
-   changes
-   license
-   authors
+.. include:: ../README.rst
+   :start-after: ========
+   :end-before: Useful links
+
+API
+===
+
+Fixtures
+--------
+.. automodule:: pytest_reana.fixtures
+   :members:
+
+Plugin
+------
+.. automodule:: pytest_reana.plugin
+   :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
diff --git a/docs/introduction.rst b/docs/introduction.rst
diff --git a/docs/license.rst b/docs/license.rst