Skip to content

Commit 241c7e9

Browse files
committed
Add warning about docs pages under construction
1 parent 9cf099f commit 241c7e9

File tree

8 files changed

+31
-8
lines changed

8 files changed

+31
-8
lines changed

docs/content/api.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: API
33
---
44

5+
@warning
6+
Page under construction.
7+
@endwarning
8+
59
# ecTrans API
610

711
## General notes
@@ -35,4 +39,3 @@ subroutines described here, only two must be considered:
3539

3640
- `INTEGER, PARAMETER :: JPIM = SELECTED_INT_KIND(9)` (i.e. 4-byte integer)
3741
- `INTEGER, PARAMETER :: JPRD = SELECTED_REAL_KIND(13,300)` (i.e. 8-byte float)
38-

docs/content/benchmarking.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22
title: Benchmarking ecTrans
33
---
44

5-
# Benchmarking ecTrans
5+
@warning
6+
Page under construction.
7+
@endwarning
8+
9+
# Benchmarking ecTrans

docs/content/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,8 @@ ordered_subpage: license.md
1010
copy_subdir: img
1111
---
1212

13-
# ecTrans
13+
@warning
14+
Page under construction.
15+
@endwarning
16+
17+
# ecTrans

docs/content/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,4 @@ cd ectrans/build
130130
ctest
131131
```
132132
If any of the tests fail, please let us know by
133-
[raising an issue](https://github.com/ecmwf-ifs/ectrans/issues)!
133+
[raising an issue](https://github.com/ecmwf-ifs/ectrans/issues)!

docs/content/introduction.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Introduction
33
---
44

5+
@warning
6+
Page under construction.
7+
@endwarning
8+
59
# Introduction
610

711
## What is ecTrans?
@@ -10,4 +14,4 @@ title: Introduction
1014

1115
## Parallelizing a spectral transform
1216

13-
## Basic usage of ecTrans
17+
## Basic usage of ecTrans

docs/content/license.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
---
22
title: License
3-
---
3+
---
4+
5+
@warning
6+
Page under construction.
7+
@endwarning

docs/content/transi.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@
22
title: Interfacing with C
33
---
44

5-
[Link to transi](transi/index.html)
5+
@warning
6+
Page under construction.
7+
@endwarning
8+
9+
[Link to transi](transi/index.html)

docs/content/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,4 +254,4 @@ WRITE(*,*) "Error = ", NORM2(SPECTRAL_FIELD_2 - SPECTRAL_FIELD)
254254
```
255255

256256
You should get an error of \( O(10^{-7}) \) which is roughly the machine epsilon of the
257-
single-precision float type \( 2^{-23} \approx 10^{-7} \). This concludes the demonstration.
257+
single-precision float type \( 2^{-23} \approx 10^{-7} \). This concludes the demonstration.

0 commit comments

Comments
 (0)