Skip to content

[doc] Improve navigation in API documentation #3016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2023
Merged

[doc] Improve navigation in API documentation #3016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
4 changes: 4 additions & 0 deletions docs/deferrable_functions_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/programming_apis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Programming APIs
================

.. toctree::
:maxdepth: 3
:maxdepth: 2

regression_test_api
deferrable_functions_reference
Expand Down
6 changes: 5 additions & 1 deletion docs/regression_test_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/utility_functions_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------------
Expand Down