Skip to content

Commit b53a924

Browse files
authored
Merge pull request #90 from branfosj/auto
Autogenerated markdown fixes
2 parents 6a410fa + 9f51190 commit b53a924

7 files changed

Lines changed: 615 additions & 511 deletions

docs/version-specific/config-file-constants.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Constants available (only) in configuration files {: #avail_cfgfile_constants }
22

3-
### Only in 'DEFAULT' section:
3+
## Only in 'DEFAULT' section:
44

55
Constant name |Constant help |Constant value
66
--------------------------|---------------------------------------------------|-------------------------------------------------------------------

docs/version-specific/easyconfig-templates.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Template name |Template value
2929
``%(rshortver)s`` |short version for R (<major>.<minor>)
3030
``%(rver)s`` |full version for R
3131

32-
Template names/values as set in easyconfig
33-
------------------------------------------
32+
## Template names/values as set in easyconfig
3433

3534
* ``%(bitbucket_account)s``
3635
* ``%(github_account)s``

docs/version-specific/eb-list-toolchains.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ Name |Compiler(s) |MPI |Linear algebra |FFT
7777
**iqacml** |icc, ifort |QLogicMPI |ACML, ScaLAPACK |FFTW
7878
**ismkl** |icc, ifort |MPICH2 |imkl |imkl
7979
**NVHPC** |NVHPC |*(none)* |*(none)* |*(none)*
80+
**nvofbf** |NVHPC |OpenMPI |FlexiBLAS, ScaLAPACK |FFTW
8081
**nvompi** |NVHPC |OpenMPI |*(none)* |*(none)*
8182
**nvompic** |NVHPC |OpenMPI |*(none)* |*(none)*
8283
**nvpsmpi** |NVHPC |psmpi |*(none)* |*(none)*

docs/version-specific/generic-easyblocks.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
## ``BinariesTarball``
1212

13-
(derives from <a href='#tarball'>``Tarball``</a>)
13+
(derives from [``Tarball``](#tarball))
1414

1515

1616
Support for installing a tarball of binaries
@@ -85,7 +85,7 @@ moduleclass = 'bio'
8585

8686
## ``BuildEnv``
8787

88-
(derives from <a href='#bundle'>``Bundle``</a>)
88+
(derives from [``Bundle``](#bundle))
8989

9090

9191
Build environment of toolchain: only generate module file
@@ -157,7 +157,7 @@ moduleclass = 'devel'
157157

158158
## ``CMakeMake``
159159

160-
(derives from <a href='#configuremake'>``ConfigureMake``</a>)
160+
(derives from [``ConfigureMake``](#configuremake))
161161

162162
Support for configuring build with CMake instead of traditional configure script
163163

@@ -229,7 +229,7 @@ moduleclass = 'data'
229229

230230
## ``CMakeMakeCp``
231231

232-
(derives from <a href='#cmakemake'>``CMakeMake``</a>, <a href='#makecp'>``MakeCp``</a>)
232+
(derives from [``CMakeMake``](#cmakemake), [``MakeCp``](#makecp))
233233

234234
Software configured with CMake but without 'make install' step
235235

@@ -270,7 +270,7 @@ easyconfig parameter |description
270270

271271
## ``CMakeNinja``
272272

273-
(derives from <a href='#cmakemake'>``CMakeMake``</a>, <a href='#mesonninja'>``MesonNinja``</a>)
273+
(derives from [``CMakeMake``](#cmakemake), [``MesonNinja``](#mesonninja))
274274

275275
Support for configuring with CMake, building and installing with MesonNinja.
276276

@@ -308,7 +308,7 @@ easyconfig parameter |description
308308

309309
## ``CMakePythonPackage``
310310

311-
(derives from <a href='#cmakemake'>``CMakeMake``</a>, <a href='#pythonpackage'>``PythonPackage``</a>)
311+
(derives from [``CMakeMake``](#cmakemake), [``PythonPackage``](#pythonpackage))
312312

313313
Build a Python package and module with cmake.
314314

@@ -372,7 +372,7 @@ easyconfig parameter |description
372372

373373
## ``CmdCp``
374374

375-
(derives from <a href='#makecp'>``MakeCp``</a>)
375+
(derives from [``MakeCp``](#makecp))
376376

377377

378378
Software with no configure, no make, and no make install step.
@@ -409,7 +409,7 @@ easyconfig parameter |description
409409

410410
## ``Conda``
411411

412-
(derives from <a href='#binary'>``Binary``</a>)
412+
(derives from [``Binary``](#binary))
413413

414414
Support for installing software using 'conda'.
415415

@@ -502,12 +502,13 @@ moduleclass = 'tools'
502502

503503
## ``ConfigureMakePythonPackage``
504504

505-
(derives from <a href='#configuremake'>``ConfigureMake``</a>, <a href='#pythonpackage'>``PythonPackage``</a>)
505+
(derives from [``ConfigureMake``](#configuremake), [``PythonPackage``](#pythonpackage))
506506

507507

508-
Build a Python package and module with 'python configure/make/make install'.
508+
Build a Python package and module with ``python configure``/``make``/``make install``.
509509

510510
Implemented by using:
511+
511512
- a custom implementation of configure_step
512513
- using the build_step and install_step from ConfigureMake
513514
- using the sanity_check_step and make_module_extra from PythonPackage
@@ -552,11 +553,11 @@ easyconfig parameter |description
552553

553554
### Customised steps in ``ConfigureMakePythonPackage`` easyblock
554555

555-
* ``build_step`` - Build Python package with 'make'.
556+
* ``build_step`` - Build Python package with ``make``.
556557

557-
* ``configure_step`` - Configure build using 'python configure'.
558+
* ``configure_step`` - Configure build using ``python configure``.
558559

559-
* ``install_step`` - Install with 'make install'.
560+
* ``install_step`` - Install with ``make install``.
560561

561562

562563
### Example easyconfig for ``ConfigureMakePythonPackage`` easyblock
@@ -596,7 +597,7 @@ moduleclass = 'vis'
596597

597598
## ``CrayToolchain``
598599

599-
(derives from <a href='#bundle'>``Bundle``</a>)
600+
(derives from [``Bundle``](#bundle))
600601

601602

602603
Compiler toolchain: generate module file only, nothing to build/install
@@ -616,7 +617,7 @@ easyconfig parameter |description
616617

617618
## ``FortranPythonPackage``
618619

619-
(derives from <a href='#pythonpackage'>``PythonPackage``</a>)
620+
(derives from [``PythonPackage``](#pythonpackage))
620621

621622
Extends PythonPackage to add a Fortran compiler to the make call
622623

@@ -683,6 +684,7 @@ easyconfig parameter|description
683684

684685

685686
Base class for Intel software
687+
686688
- no configure/make : binary release
687689
- add license_file variable
688690

@@ -709,7 +711,7 @@ easyconfig parameter |description
709711

710712
## ``JAR``
711713

712-
(derives from <a href='#binary'>``Binary``</a>)
714+
(derives from [``Binary``](#binary))
713715

714716
Support for installing JAR files.
715717

@@ -724,7 +726,7 @@ easyconfig parameter|description
724726

725727
## ``JuliaBundle``
726728

727-
(derives from <a href='#bundle'>``Bundle``</a>)
729+
(derives from [``Bundle``](#bundle))
728730

729731

730732
Bundle of JuliaPackages: install Julia packages as extensions in a bundle
@@ -769,7 +771,7 @@ easyconfig parameter |description
769771

770772
## ``MakeCp``
771773

772-
(derives from <a href='#configuremake'>``ConfigureMake``</a>)
774+
(derives from [``ConfigureMake``](#configuremake))
773775

774776

775777
Software with no configure and no make install step.
@@ -880,7 +882,7 @@ easyconfig parameter|description |default value
880882

881883
## ``PackedBinary``
882884

883-
(derives from <a href='#binary'>``Binary``</a>, ``EasyBlock``)
885+
(derives from [``Binary``](#binary), ``EasyBlock``)
884886

885887
Support for installing packed binary software.
886888
Just unpack the sources in the install dir
@@ -902,7 +904,7 @@ easyconfig parameter|description
902904

903905
## ``PerlModule``
904906

905-
(derives from ``ExtensionEasyBlock``, <a href='#configuremake'>``ConfigureMake``</a>)
907+
(derives from ``ExtensionEasyBlock``, [``ConfigureMake``](#configuremake))
906908

907909
Builds and installs a Perl module, and can provide a dedicated module file.
908910

@@ -924,7 +926,7 @@ easyconfig parameter|description |default value
924926

925927
## ``PythonBundle``
926928

927-
(derives from <a href='#bundle'>``Bundle``</a>)
929+
(derives from [``Bundle``](#bundle))
928930

929931

930932
Bundle of PythonPackages: install Python packages as extensions in a bundle
@@ -1032,10 +1034,11 @@ easyconfig parameter|description |de
10321034

10331035
## ``Rpm``
10341036

1035-
(derives from <a href='#binary'>``Binary``</a>)
1037+
(derives from [``Binary``](#binary))
10361038

10371039

10381040
Support for installing RPM files.
1041+
10391042
- sources is a list of rpms
10401043
- installation is with --nodeps (so the sources list has to be complete)
10411044

@@ -1105,7 +1108,7 @@ easyconfig parameter|description |default value
11051108

11061109
## ``SystemCompiler``
11071110

1108-
(derives from <a href='#bundle'>``Bundle``</a>, ``EB_GCC``, ``EB_ifort``)
1111+
(derives from [``Bundle``](#bundle), ``EB_GCC``, ``EB_ifort``)
11091112

11101113

11111114
Support for generating a module file for the system compiler with specified name.
@@ -1162,7 +1165,7 @@ easyconfig parameter |description
11621165

11631166
## ``SystemMPI``
11641167

1165-
(derives from <a href='#bundle'>``Bundle``</a>, <a href='#configuremake'>``ConfigureMake``</a>, ``EB_impi``)
1168+
(derives from [``Bundle``](#bundle), [``ConfigureMake``](#configuremake), ``EB_impi``)
11661169

11671170

11681171
Support for generating a module file for the system mpi with specified name.
@@ -1214,8 +1217,7 @@ easyconfig parameter |description
12141217
(derives from ``ExtensionEasyBlock``)
12151218

12161219

1217-
Precompiled software supplied as a tarball:
1218-
- will unpack binary and copy it to the install dir
1220+
Precompiled software supplied as a tarball: will unpack binary and copy it to the install dir
12191221

12201222

12211223
### Extra easyconfig parameters specific to ``Tarball`` easyblock
@@ -1237,7 +1239,7 @@ easyconfig parameter|description
12371239

12381240
## ``Toolchain``
12391241

1240-
(derives from <a href='#bundle'>``Bundle``</a>)
1242+
(derives from [``Bundle``](#bundle))
12411243

12421244
Compiler toolchain easyblock: nothing to install, just generate module file.
12431245

@@ -1256,7 +1258,7 @@ easyconfig parameter |description
12561258

12571259
## ``VSCPythonPackage``
12581260

1259-
(derives from <a href='#versionindependentpythonpackage'>``VersionIndependentPythonPackage``</a>)
1261+
(derives from [``VersionIndependentPythonPackage``](#versionindependentpythonpackage))
12601262

12611263
Support for install VSC Python packages.
12621264

@@ -1288,7 +1290,7 @@ easyconfig parameter |description
12881290

12891291
## ``VersionIndependentPythonPackage``
12901292

1291-
(derives from <a href='#pythonpackage'>``PythonPackage``</a>)
1293+
(derives from [``PythonPackage``](#pythonpackage))
12921294

12931295
Support for building/installing python packages without requiring a specific python package.
12941296

0 commit comments

Comments
 (0)