Skip to content

[bugfix] Enable sphinx versioning only for releases #361

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
Jul 18, 2018
Merged

[bugfix] Enable sphinx versioning only for releases #361

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/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,4 +237,4 @@

# Versioning
scv_whitelist_branches = ('master',)
scv_whitelist_tags = (re.compile(r'^v\d+\.\d+(\.d+)?[a-z]?'),)
scv_whitelist_tags = (re.compile(r'^v\d+\.\d+$'),)
14 changes: 7 additions & 7 deletions docs/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To make a test visible to the framework, you must decorate your final test class
Let's see in more detail how the ``Example1Test`` is defined:

.. literalinclude:: ../tutorial/example1.py
:lines: 5-8
:lines: 4-7

The ``__init__()`` method is the constructor of your test.
It is usually the only method you need to implement for your tests, especially if you don't want to customize any of the regression test pipeline stages.
Expand All @@ -60,7 +60,7 @@ You may change the name of the test later in the constructor by setting the :att
The next line sets a more detailed description of the test:

.. literalinclude:: ../tutorial/example1.py
:lines: 9
:lines: 8
:dedent: 8

This is optional and it defaults to the auto-generated test's name, if not specified.
Expand All @@ -71,7 +71,7 @@ This is optional and it defaults to the auto-generated test's name, if not speci
The next two lines specify the systems and the programming environments that this test is valid for:

.. literalinclude:: ../tutorial/example1.py
:lines: 10-11
:lines: 9-10
:dedent: 8

Both of these variables accept a list of system names or environment names, respectively.
Expand All @@ -87,7 +87,7 @@ If only a system name (without a partition) is specified in the :attr:`self.vali
The next line specifies the source file that needs to be compiled:

.. literalinclude:: ../tutorial/example1.py
:lines: 12
:lines: 11
:dedent: 8

ReFrame expects any source files, or generally resources, of the test to be inside an ``src/`` directory, which is at the same level as the regression test file.
Expand All @@ -109,7 +109,7 @@ A user can associate compilers with programming environments in the ReFrame's `s
The next line in our first regression test specifies a list of options to be used for running the generated executable (the matrix dimension and the number of iterations in this particular example):

.. literalinclude:: ../tutorial/example1.py
:lines: 13
:lines: 12
:dedent: 8

Notice that you do not need to specify the executable name.
Expand All @@ -119,7 +119,7 @@ We will see in the `"Customizing Further A ReFrame Regression Test" <advanced.ht
The next lines specify what should be checked for assessing the sanity of the result of the test:

.. literalinclude:: ../tutorial/example1.py
:lines: 14-15
:lines: 13-14
:dedent: 8

This expression simply asks ReFrame to look for ``time for single matrix vector multiplication`` in the standard output of the test.
Expand All @@ -140,7 +140,7 @@ You can also use the :attr:`stdout <reframe.core.pipeline.RegressionTest.stdout>
The last two lines of the regression test are optional, but serve a good role in a production environment:

.. literalinclude:: ../tutorial/example1.py
:lines: 16-17
:lines: 15-16
:dedent: 8

In the :attr:`maintainers <reframe.core.pipeline.RegressionTest.maintainers>` attribute you may store a list of people responsible for the maintenance of this test.
Expand Down