The generated documentation will look like figure Fig.1

Sphinx screenshot

Title: typical sphinx html documentation

Configuration file

A typical example configuration file is conf.py:

1
2
3
import re
import sys
import sphinx_rtd_theme

Reference Guide

This page tests links, see started.rst.

Foo Documentation

automodule

  • reframechecks.common.sphexa/foo.py

foo module.

autoclass

  • reframechecks.common.sphexa/foo.py -> class Foo:
class reframechecks.common.sphexa.foo.Foo[source]

Bases: object

Foo class.

bye(name)[source]

Print bye addressed to name.

Args:
name (str): Name to address.

automethod

  • reframechecks.common.sphexa/foo.py ->
foo.hello()

Print hello addressed to name.

Args:
name (str): Name to address.

autofunction

reframechecks.common.sphexa.foo.seconds_neigh(self)[source]

Reports FindNeighbors time in seconds using the internal timer from the code

reframechecks.common.sphexa.foo.square(a)[source]

short description of the function square

longish explanation: returns the square of a: a^2

Parameters:a – an input argument
Returns:a*a
reframechecks.common.sphexa.foo.hello(name)[source]

Print hello addressed to name.

Args:
name (str): Name to address.

TODO

Howto

class RegressionTest(metaclass=RegressionTestMeta):
    '''Base class for regression tests.'''
    #: The set of reference values for this test.
    #:
    #: The reference values are specified as a scoped dictionary keyed on the
    #: performance variables defined in :attr:`perf_patterns` and scoped under
    #: the system/partition combinations.
    #: The reference itself is a three- or four-tuple that contains the
    #: reference value, the lower and upper thresholds and, optionally, the
    #: measurement unit.
    #: An example follows:
    #:
    #: .. code:: python
    #:
    #:    self.reference = {
    #:        'sys0:part0': {
    #:            'perfvar0': (50, -0.1, 0.1, 'Gflop/s'),
    #:            'perfvar1': (20, -0.1, 0.1, 'GB/s')
    #:        },
    #:        'sys0:part1': {
    #:            'perfvar0': (100, -0.1, 0.1, 'Gflop/s'),
    #:            'perfvar1': (40, -0.1, 0.1, 'GB/s')
    #:        }
    #:    }
    #:
    #: :type: A scoped dictionary with system names as scopes or :class:`None`
    #: :default: ``{}``
    reference = fields.ScopedDictField('reference', typ.Tuple[object])

    @property
    def current_environ(self):
        '''The programming environment that the regression test is currently
        executing with.

        This is set by the framework during the :func:`setup` phase.

        :type: :class:`reframechecks.common.sphexa.environments.Environment`.
        '''
        return self._current_environ

JG Cheatsheet

# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

Part title..

Chapter title..

Section title..

Subsection title..

Subsubsection title..
Paragrapth title..
Paragrapth title..
Subtitle: Titles
  • All sections marked with the same adornment style are deemed to be at the same level:

Chapter 1 Title

Section 1.1

Section 1.2

Chapter 2 Title

etc…

italic / bold / interpreted / inline / None

A B
a b
aa bb

New in version 0.1.

Changed in version 0.1.

Caution

this is a caution

Warning

this is a warning

Tip

this is a tip

Note

this is a note

Notice space after ::

Command line: ./bin/reframe -C tutorial/config/settings.py \
 -c tutorial/example1.py -r
Reframe version: 2.x

> $EBROOTREFRAME/bin/reframe -r $SCRATCH/example1.py

import os

#!/bin/bash -l
#SBATCH --job-name="rfm_Example1Test_job"
export X=`date`

see 1

Indices and tables