diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index a9b8bbda23..e25c95472c 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -14,7 +14,7 @@ {% endblock %} diff --git a/docs/deferrable_functions_reference.rst b/docs/deferrable_functions_reference.rst index 1a173f04fd..26ab9bbcbc 100644 --- a/docs/deferrable_functions_reference.rst +++ b/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 ------------------------------------------- diff --git a/docs/programming_apis.rst b/docs/programming_apis.rst index c204883fde..1372447732 100644 --- a/docs/programming_apis.rst +++ b/docs/programming_apis.rst @@ -3,7 +3,7 @@ Programming APIs ================ .. toctree:: - :maxdepth: 3 + :maxdepth: 2 regression_test_api deferrable_functions_reference diff --git a/docs/regression_test_api.rst b/docs/regression_test_api.rst index dc5695eb0d..9b839362c7 100644 --- a/docs/regression_test_api.rst +++ b/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 diff --git a/docs/utility_functions_reference.rst b/docs/utility_functions_reference.rst index 068a51ac00..25c2b4c570 100644 --- a/docs/utility_functions_reference.rst +++ b/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 -----------------