Merge pull request #3016 from vkarak/doc/restructure-api-docs

[doc] Improve navigation in API documentation

Author: vkarak

docs/_templates/layout.html

@@ -14,7 +14,7 @@
     <ul>
       <li class="toctree-l1"><a class="reference internal" href="https://github.com/reframe-hpc/reframe" target="_blank">ReFrame Github repo</a></li>
       <li class="toctree-l1"><a class="reference internal" href="https://github.com/reframe-hpc" target="_blank">ReFrame site tests</a></li>
-      <li class="toctree-l1"><a class="reference internal" href="https://reframe-slack.herokuapp.com/" target="_blank">ReFrame's Slack workspace</a></li>
+      <li class="toctree-l1"><a class="reference internal" href="https://join.slack.com/t/reframetalk/shared_invite/zt-1tar8s71w-At0tolJ~~zxT2oG_2Ly9sw" target="_blank">ReFrame's Slack workspace</a></li>
       <li class="toctree-l1"><a class="reference internal" href="https://twitter.com/ReFrameHPC" target="_blank">@ReFrameHPC on Twitter</a></li>
     </ul>
 {% endblock %}

docs/deferrable_functions_reference.rst

@@ -10,6 +10,10 @@ The key characteristic of these functions is that they store their arguments whe
 ReFrame provides an ample set of deferrable utilities and it also allows users to write their own deferrable functions when needed.
 Please refer to ":doc:`deferrables`" for a hands-on explanation on how deferrable functions work and how to create custom deferrable functions.
 
+.. contents:: Contents
+   :local:
+   :backlinks: entry
+
 
 Explicit evaluation of deferrable functions
 -------------------------------------------

docs/programming_apis.rst

@@ -3,7 +3,7 @@ Programming APIs
 ================
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
 
    regression_test_api
    deferrable_functions_reference

docs/regression_test_api.rst

@@ -6,7 +6,11 @@ This page provides a reference guide of the ReFrame API for writing regression t
 Internal data structures and APIs are covered only to the extent that this might be helpful to the final user of the framework.
 
 
- .. _regression-bases:
+.. contents:: Contents
+   :local:
+   :backlinks: entry
+
+.. _regression-bases:
 
 -----------------
 Test Base Classes

docs/utility_functions_reference.rst

@@ -7,6 +7,10 @@ Utility Functions
 This is a collection of utility functions and classes that are used by the framework but can also be useful when writing regression tests.
 Functions or classes marked as draft should be used with caution, since they might change or be replaced without a deprecation warning.
 
+.. contents:: Contents
+   :local:
+   :backlinks: entry
+
 
 General Utilities
 -----------------