Skip to content

Commit 5625eb0

Browse files
authored
Merge pull request #187 from MultiSimOLab/pages-logo
Minor fixes in documentation links
2 parents 0ad3951 + 72f508d commit 5625eb0

8 files changed

Lines changed: 17 additions & 10 deletions

File tree

.github/workflows/docs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@ on:
44
push:
55
branches: [ main ]
66
tags: ['*']
7+
pull_request:
8+
branches: [ main ]
9+
paths: [ "docs/**" ]
710
workflow_dispatch:
811

12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
15+
916
jobs:
1017
docs:
1118
name: Documentation

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img src="https://github.com/jmartfrut/HyperFEM/raw/main/docs/imgs/logo.png" width="30%"></p>
1+
<p align="center"><img src="https://github.com/MultiSimOLab/HyperFEM.jl/raw/main/docs/img/logo.png" width="30%"></p>
22

33
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://multisimolab.github.io/HyperFEM.jl/stable/)
44
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://multisimolab.github.io/HyperFEM.jl/dev/)
@@ -129,7 +129,7 @@ x = solve!(comp_model; stepping=(nsteps=5, maxbisec=5), post=post_model)
129129

130130
## HyperFEM Gallery
131131

132-
<p align="center"><img src="https://github.com/MultiSimOLab/HyperFEM/raw/main/docs/imgs/sims_.png" width="110%"></p>
132+
![img](https://github.com/MultiSimOLab/HyperFEM.jl/raw/main/docs/img/sims.png)
133133

134134

135135

@@ -138,7 +138,6 @@ x = solve!(comp_model; stepping=(nsteps=5, maxbisec=5), post=post_model)
138138
In order to give credit to the HyperFEM contributors, we ask that you please reference the paper:
139139

140140
C. Perez‐Garcia, R. Ortigosa, J. Martínez‐Frutos, and D. Garcia‐Gonzalez, **Topology and material optimization in ultra-soft magnetoactive structures: making advantage of residual anisotropies.** Adv. Mater. (2025): e18489. https://doi.org/10.1002/adma.202518489
141-
142141

143142
along with the required citations for [Gridap](https://github.com/gridap/Gridap.jl).
144143

@@ -147,7 +146,7 @@ along with the required citations for [Gridap](https://github.com/gridap/Gridap.
147146

148147
- Grants PID2022-141957OA-C22/PID2022-141957OB-C22 funded by MCIN/AEI/ 10.13039/501100011033 and by ''ERDF A way of making Europe''
149148

150-
<p align="center"><img src="https://github.com/MultiSimOLab/HyperFEM/raw/main/docs/imgs/aei.png" width="70%"></p>
149+
<p align="center"><img src="https://github.com/MultiSimOLab/HyperFEM.jl/raw/main/docs/img/aei.png" width="70%"></p>
151150

152151
## Contact
153152

File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/make.jl

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ readme_path = joinpath(@__DIR__, "..", "README.md")
55
index_path = joinpath(@__DIR__, "src", "index.md")
66

77
readme_content = read(readme_path, String)
8-
readme_content = replace(
9-
readme_content,
10-
r"(<p align=\"center\"><img.*?</p>)" => s"```@raw html\n\1\n```"
11-
)
8+
header_start = findfirst("# Multiphysics", readme_content)
9+
readme_content = header_start !== nothing ? readme_content[header_start.start:end] : readme_content
10+
readme_content = replace(readme_content, r"(<p align=\"center\"><img.*?</p>)" => s"```@raw html\n\1\n```")
1211
write(index_path, readme_content)
1312

1413
makedocs(
@@ -25,7 +24,7 @@ makedocs(
2524
HyperFEM.ComputationalModels
2625
],
2726
pages = [
28-
"HyperFEM" => "index.md", # Inject README.md (previously cloned into index.md)
27+
"Home" => "index.md", # Inject README.md (previously cloned into index.md)
2928
"Tutorials" => "tutorials.md", # Point to the tutorials repository
3029
"API reference" => "api.md" # Inject the docstrings from the code
3130
],
@@ -34,7 +33,9 @@ makedocs(
3433
canonical = "https://MultiSimOLab.github.io/HyperFEM.jl",
3534
),
3635
checkdocs = :none,
37-
warnonly = true
36+
warnonly = false,
37+
linkcheck = true,
38+
linkcheck_ignore = [r"^mailto:"],
3839
)
3940

4041
deploydocs(

docs/src/assets/logo.png

598 KB
Loading

0 commit comments

Comments
 (0)