WIP: New tutorial

reframe-hpc · Feb 22, 2024 · 8a961f6 · 8a961f6
1 parent d8b25bb
commit 8a961f6
Show file tree

Hide file tree

Showing 39 changed files with 2,704 additions and 18 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2016-2022, Swiss National Supercomputing Center (CSCS/ETH Zurich)
+Copyright (c) 2016-2023, Swiss National Supercomputing Center (CSCS/ETH Zurich)
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/docs/_static/img/test-naming.svg b/docs/_static/img/test-naming.svg
diff --git a/docs/howto.rst b/docs/howto.rst
@@ -0,0 +1,4 @@
+ReFrame How Tos
+===============
+
+This is a collection of "How To" articles on specific ReFrame usage topics.
diff --git a/docs/index.rst b/docs/index.rst
@@ -44,11 +44,11 @@ Webinars and Tutorials
 
 .. toctree::
    :caption: Table of Contents
-   :maxdepth: 2
 
    started
    whats_new_40
-   tutorials
+   tutorial
+   howto
    configure
    topics
    manuals

diff --git a/docs/manpage.rst b/docs/manpage.rst
@@ -243,7 +243,7 @@ An action must always be specified.
    For more information, have a look in :ref:`generate-ci-pipeline`.
 
    .. note::
-      This option will not work with the `test generation options <#test-generators>`.
+      This option will not work with the :ref:`test generation options <test-generators>`.
 
 
    .. versionadded:: 3.4.1
@@ -575,7 +575,7 @@ Options controlling ReFrame execution
       This is not a problem when rerunning a failed case, since the stage directories of its dependencies are automatically kept, but if you want to rerun a successful test case, you should make sure to have run with the :option:`--keep-stage-files` option.
 
    .. note::
-      This option will not work with the `test generation options <#test-generators>`.
+      This option will not work with the :ref:`test generation options <test-generators>`.
 
    .. versionadded:: 3.4
 

diff --git a/docs/started.rst b/docs/started.rst
@@ -105,6 +105,10 @@ The ``./bootstrap.sh`` has two additional variant options:
       The bootstrap script for ReFrame was added.
       For previous ReFrame versions you should install its requirements using ``pip install -r requirements.txt`` in a Python virtual environment.
 
+   .. versionchanged:: 4.5
+      ReFrame supports now multiarch builds and it will place all of its dependencies in an arch-specific directory under its prefix.
+      Also, ``pip`` is no more required, as the bootstrap script will start a virtual environment without ``pip`` and will fetch a fresh ``pip``, which will be used to install the dependencies.
+
 
 Enabling auto-completion
 ------------------------