Skip to content

Commit d89549c

Browse files
committed
doc - hide inclusion markers in md
1 parent 4db02c8 commit d89549c

File tree

7 files changed

+12
-12
lines changed

7 files changed

+12
-12
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The CEED research is supported by the [Exascale Computing Project](https://exasc
2727

2828
For more details on the CEED API see the [user manual](https://libceed.org/en/latest/).
2929

30-
% gettingstarted-inclusion-marker
30+
<!-- % gettingstarted-inclusion-marker-->
3131

3232
## Building
3333

@@ -254,7 +254,7 @@ To build the examples, set the `MFEM_DIR`, `PETSC_DIR` (and optionally `PETSC_AR
254254
$ cd examples/
255255
```
256256

257-
% running-examples-inclusion-marker
257+
<!-- % running-examples-inclusion-marker-->
258258

259259
```console
260260
# libCEED examples on CPU and GPU
@@ -337,7 +337,7 @@ The above code assumes a GPU-capable machine with the CUDA backends enabled.
337337
Depending on the available backends, other CEED resource specifiers can be provided with the `-ceed` option.
338338
Other command line arguments can be found in [examples/petsc](https://github.com/CEED/libCEED/blob/main/examples/petsc/README.md).
339339

340-
% benchmarks-marker
340+
<!-- % benchmarks-marker-->
341341

342342
## Benchmarks
343343

doc/sphinx/source/gettingstarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Getting Started
22

33
```{include} ./README.md
4-
:start-after: gettingstarted-inclusion-marker
4+
:start-after: gettingstarted-inclusion-marker-->
55
```

examples/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ For more details, please see the dedicated [documentation section](https://libce
99

1010
## Bakeoff Problems
1111

12-
% bps-inclusion-marker
12+
<!-- % bps-inclusion-marker-->
1313

1414
The Center for Efficient Exascale Discretizations (CEED) uses Bakeoff Problems (BPs) to test and compare the performance of high-order finite element implementations.
1515
The definitions of the problems are given on the ceed [website](https://ceed.exascaleproject.org/bps/).
@@ -46,7 +46,7 @@ The BPs are parametrized by the number $P$ of Gauss-Legendre-Lobatto nodal point
4646
A $Q$-point Gauss-Legendre quadrature is used for all BPs except BP5 and BP6, which choose $Q = P$ and Gauss-Legendre-Lobatto quadrature to collocate with the interpolation nodes.
4747
This latter choice is popular in applications that use spectral element methods because it produces a diagonal mass matrix (enabling easy explicit time integration) and significantly reduces the number of floating point operations to apply the operator.
4848

49-
% bps-exclusion-marker
49+
<!-- % bps-exclusion-marker-->
5050

5151
For a more detailed description of the operators employed in the BPs, please see the dedicated [BPs documentation section](https://libceed.org/en/latest/examples/bps.html).
5252

@@ -75,6 +75,6 @@ For a detailed description, please see the corresponding [problems on the cubed-
7575
To build the examples, set the `MFEM_DIR`, `PETSC_DIR`, and `NEK5K_DIR` variables and, from the `examples/` directory, run
7676

7777
```{include} ../README.md
78-
:start-after: running-examples-inclusion-marker
79-
:end-before: benchmarks-marker
78+
:start-after: running-examples-inclusion-marker-->
79+
:end-before: benchmarks-marker-->
8080
```

examples/fluids/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ and run with:
2323

2424
## Runtime options
2525

26-
% inclusion-fluids-marker
26+
<!-- % inclusion-fluids-marker-->
2727

2828
The Navier-Stokes mini-app is controlled via command-line options.
2929
The following options are common among all problem types:

examples/fluids/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Moreover, the Navier-Stokes example has been developed using PETSc, so that the
99
## Running the mini-app
1010

1111
```{include} README.md
12-
:start-after: inclusion-fluids-marker
12+
:start-after: inclusion-fluids-marker-->
1313
```
1414
## The Navier-Stokes equations
1515

examples/solids/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ and run with:
2222

2323
## Runtime options
2424

25-
% inclusion-solids-marker
25+
<!-- % inclusion-solids-marker-->
2626

2727
The elasticity mini-app is controlled via command-line options, the following of which are mandatory.
2828

examples/solids/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ $$ (hyperelastic-cd)
3434
## Running the mini-app
3535
3636
```{include} README.md
37-
:start-after: inclusion-solids-marker
37+
:start-after: inclusion-solids-marker-->
3838
```
3939
4040
(problem-linear-elasticity)=

0 commit comments

Comments
 (0)