docs: single-page RTFD outline

addresses reanahub/reana#335
tiborsimko · Jul 29, 2020 · ce07a07 · ce07a07
1 parent b2eae27
commit ce07a07
Show file tree

Hide file tree

Showing 14 changed files with 87 additions and 96 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 @@
-=========
- REANA DB
-=========
+########
+REANA DB
+########
 
 .. image:: https://img.shields.io/pypi/pyversions/reana-db.svg
       :target: https://pypi.org/pypi/reana-db
@@ -24,26 +24,33 @@
    :target: https://github.com/psf/black
 
 About
------
+=====
 
 REANA-DB is a component of the `REANA
-<http://reanahub.io/>`_ reusable analysis platform.
+<http://www.reana.io/>`_ reusable analysis platform.
 It contains REANA database models and utilities.
 
 Features
---------
+========
 
 - database persistence for REANA system
 - database models and utilities
 - database upgrades and migrations
 
+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-db.readthedocs.io/>`_
-- `releases <https://github.com/reanahub/reana-db/releases>`_
-- `known issues <https://github.com/reanahub/reana-db/issues>`_
-- `source code <https://github.com/reanahub/reana-db>`_
+- `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
-general `REANA documentation <http://reana.readthedocs.io/>`_.
+- `REANA-DB releases <https://reana-db.readthedocs.io/en/latest#changes>`_
+- `REANA-DB developer documentation <https://reana-db.readthedocs.io/>`_
+- `REANA-DB known issues <https://github.com/reanahub/reana-db/issues>`_
+- `REANA-DB source code <https://github.com/reanahub/reana-db>`_
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
@@ -46,6 +46,7 @@
     "sphinx.ext.graphviz",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
+    "sphinx_click.ext",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -62,7 +63,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
@@ -128,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/configuration.rst b/docs/configuration.rst
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -2,16 +2,64 @@
    :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_db.config
+   :members:
+
+
+API
+===
+
+Database management
+-------------------
+
+.. automodule:: reana_db.database
+   :members:
+
+Models
+------
+
+.. automodule:: reana_db.models
+   :members:
+
+Utilities
+---------
+
+.. automodule:: reana_db.utils
+   :members:
+
+
+CLI API
+=======
+
+.. click:: reana_db.cli:cli
+   :prog: reana-db
+   :show-nested:
+
+.. 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
@@ -23,7 +23,7 @@
 ]
 
 extras_require = {
-    "docs": ["Sphinx>=1.4.4", "sphinx-rtd-theme>=0.1.9",],
+    "docs": ["Sphinx>=1.4.4", "sphinx-rtd-theme>=0.1.9", "sphinx-click>=1.0.4",],
     "tests": tests_require,
 }