search

reframe-hpc / reframe

A powerful Python framework for writing and running portable regression tests and benchmarks for HPC systems.
https://reframe-hpc.readthedocs.org
BSD 3-Clause "New" or "Revised" License
213 stars 98 forks source link

[doc] Display Python imports in the first tutorial example #3195

Closed createyourpersonalaccount closed 1 month ago

createyourpersonalaccount commented 1 month ago

The tutorial was skipping the two imports

import reframe as rfm
import reframe.utility.sanity as sn

by using the :pyobject: option to only highlight stream_test. This is the first example shown in the tutorial and it is important that the entire file is displayed.

Presumably this technique is used to avoid the license notice; we can use :start-at: instead.

jenkins-cscs commented 1 month ago

Can I test this patch?