Skip to content

Commit 1a4f575

Browse files
typo fixes and add extra sed command to strip file paths (#135)
1 parent aeb39ea commit 1a4f575

File tree

4 files changed

+8
-7
lines changed

4 files changed

+8
-7
lines changed

Documentation/docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# TL;DR. What you can do with HOHQMesh<a name="WhatToDo"></a>
33

4-
To use HOHQMesh to generate all-quadrilateral meshes with arbitrary order boundary elements you use a [control file](the-controlfile.md) to
4+
To use HOHQMesh to generate all-quadrilateral meshes with arbitrary order boundary elements you use a [control file](the-control-file.md) to
55

66
- Define a [`MODEL`](the-model.md#TheModel) consisting of
77
- An optional closed outer [boundary curve](the-model.md#Boundaries) made up of one or a chain of curved segments defined by primitives like straight [line segments](the-model.md#EndPointsLine), [circular arcs](the-model.md#CircularArc), [elliptic arcs](the-model.md#ParametricEqn), [splines](the-model.md#Spline), or [equations](the-model.md#ParametricEqn)

Documentation/mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ markdown_extensions:
4949
generic: true
5050
- toc:
5151
permalink: true
52-
- pymdownx.emoji:
53-
emoji_index: !!python/name:materialx.emoji.twemoji
54-
emoji_generator: !!python/name:material.extensions.emoji.to_svg
52+
# - pymdownx.emoji:
53+
# emoji_index: !!python/name:materialx.emoji.twemoji
54+
# emoji_generator: !!python/name:material.extensions.emoji.to_svg
5555
- pymdownx.superfences
5656

5757
extra_javascript:

Documentation/preparedocs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ cp README.md docs/building-the-documentation.md
99

1010
sed -i.bak "s/\[AUTHORS.md\](AUTHORS.md)/the [Authors](authors.md) section/" docs/index.md
1111
sed -i.bak "s/\[LICENSE.md\](LICENSE.md)/the [License](license.md) section/" docs/index.md
12+
sed -i.bak 's|](Documentation/docs/\([^)]*\))|]\(\1)|g' docs/index.md
1213
sed -i.bak "s/\[gallery\](Documentation\/docs\/Gallery.md)/\[gallery\](Gallery.md)/" docs/index.md
1314
sed -i.bak "s/\[LICENSE.md\](LICENSE.md)/the [License](license.md) section/" docs/authors.md
1415
sed -i.bak "s/\[AUTHORS.md\](AUTHORS.md)/[Authors](authors.md)/" docs/license.md

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ please see the [gallery](https://trixi-framework.github.io/HOHQMesh/Gallery/).
1919

2020
# What you can do with HOHQMesh<a name="WhatToDo"></a>
2121

22-
To use HOHQMesh to generate all-quadrilateral meshes with arbitrary order boundary elements you use a [control file](Documentation/docs/the-controlfile.md) to
22+
To use HOHQMesh to generate all-quadrilateral meshes with arbitrary order boundary elements you use a [control file](Documentation/docs/the-control-file.md) to
2323

2424
- Define a [`MODEL`](Documentation/docs/the-model.md#TheModel) consisting of
2525
- An optional closed outer [boundary curve](Documentation/docs/the-model.md#Boundaries) made up of one or more connected curved segments defined by primitives like straight [line segments](Documentation/docs/the-model.md#EndPointsLine), [circular arcs](Documentation/docs/the-model.md#CircularArc), [elliptic arcs](Documentation/docs/the-model.md#ParametricEqn), [splines](Documentation/docs/the-model.md#Spline), or [equations](Documentation/docs/the-model.md#ParametricEqn)
2626
- Zero or more closed inner boundary curves defined in the same way
2727
- Zero or more internal boundary curves that define boundaries for multiple material applications
28-
- An optional bottom [topography](Documentation/docs/three-dimensional-hexahedral-meshes.md#Topography) defined either in functional form or from a file to use to [refine](Documentation/docs/the-model.md.md#SizingTopography) a 2D mesh around bottom features. (For example for shallow water equation computations.)
28+
- An optional bottom [topography](Documentation/docs/three-dimensional-hexahedral-meshes.md#Topography) defined either in functional form or from a file to use to [refine](Documentation/docs/the-model.md#SizingTopography) a 2D mesh around bottom features. (For example for shallow water equation computations.)
2929

3030
- Tell it how to mesh the model with a [`CONTROL_INPUT`](Documentation/docs/the-control-input.md) section by
3131
- Setting [run parameters](Documentation/docs/the-control-input.md#RunParameters) that specify where to write the results, specify the mesh and plot file formats and set the polynomial order of the boundary curves
@@ -124,7 +124,7 @@ make -j 4 FC=gfortran-10
124124
```
125125

126126
#### Using CMake
127-
For a CMake-based build, you first need to build the
127+
For a CMake-based build, you first need to build the
128128
[FTObjectLibrary](https://github.com/trixi-framework/FTObjectLibrary), install it, and then
129129
build HOHQMesh itself. If you followed the steps for obtaining the sources
130130
[above](#obtaining-the-sources), all required files are already present.

0 commit comments

Comments
 (0)