Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@ on:
push:
branches: [ main ]
tags: ['*']
pull_request:
branches: [ main ]
paths: [ "docs/**" ]
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}

jobs:
docs:
name: Documentation
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center"><img src="https://github.com/jmartfrut/HyperFEM/raw/main/docs/imgs/logo.png" width="30%"></p>
<p align="center"><img src="https://github.com/MultiSimOLab/HyperFEM.jl/raw/main/docs/img/logo.png" width="30%"></p>

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

## HyperFEM Gallery

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



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

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


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

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

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

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

## Contact

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
13 changes: 7 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ readme_path = joinpath(@__DIR__, "..", "README.md")
index_path = joinpath(@__DIR__, "src", "index.md")

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

makedocs(
Expand All @@ -25,7 +24,7 @@ makedocs(
HyperFEM.ComputationalModels
],
pages = [
"HyperFEM" => "index.md", # Inject README.md (previously cloned into index.md)
"Home" => "index.md", # Inject README.md (previously cloned into index.md)
"Tutorials" => "tutorials.md", # Point to the tutorials repository
"API reference" => "api.md" # Inject the docstrings from the code
],
Expand All @@ -34,7 +33,9 @@ makedocs(
canonical = "https://MultiSimOLab.github.io/HyperFEM.jl",
),
checkdocs = :none,
warnonly = true
warnonly = false,
linkcheck = true,
linkcheck_ignore = [r"^mailto:"],
)

deploydocs(
Expand Down
Binary file added docs/src/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading