Added docs.yml

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main ]
+    tags: ['*']
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+jobs:
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # write to gh-pages
+      statuses: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1' # latest stable Julia 1.x
+      - uses: julia-actions/cache@v1
+      - name: Install dependencies
+        run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: julia --project=docs docs/make.jl

.gitignore

@@ -2,5 +2,7 @@ Manifest.toml
 results/
 debug/
 data/sims/
+docs/build/
+docs/src/index.md
 **/.DS_Store
 .vscode/

README.md

@@ -1,11 +1,4 @@
- <p align="center"> 
-&nbsp; &nbsp; &nbsp; &nbsp;
-<img alt="Dark"
-src="https://github.com/jmartfrut/HyperFEM/blob/main/docs/imgs/logo.png?raw=true" width="30%">
-</p>
-
-
-<!-- # HyperFEM :construction: :construction: :construction: **Work in progress** :construction: :construction: :construction: -->
+<p align="center"><img src="https://github.com/jmartfrut/HyperFEM/raw/main/docs/imgs/logo.png" width="30%"></p>
 
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://jmartfrut.github.io/HyperFEM.jl/stable/)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://jmartfrut.github.io/HyperFEM.jl/dev/)
@@ -14,13 +7,8 @@ src="https://github.com/jmartfrut/HyperFEM/blob/main/docs/imgs/logo.png?raw=true
 
 # Multiphysics Simulation of Multifunctional Soft Materials
 
-<div align="justify" style="margin-left: 40px; margin-right: 40px;">
-
 **HyperFEM** is a library within the [Gridap](https://github.com/gridap/Gridap.jl) ecosystem designed for the simulation of multiphysics problems involving multifunctional hyperelastic materials. The ultimate goal of HyperFEM is to provide a **high-level, expressive, and rapid prototyping tool** that accelerates the modeling stages of **Thermo–Electro–Magneto–Mechanical** multiphysics problems. To this end, it includes a comprehensive library of **analytically derived constitutive models** formulated through tensor algebra. In addition, HyperFEM provides abstractions for **monolithic and staggered solution schemes**, extending Gridap’s capabilities in the context of **nonlinear solid mechanics**.
 
-</div>
-
-
 
 ## Installation
 Open the Julia REPL, type `]` to enter package mode, and install as follows
@@ -141,12 +129,7 @@ x = solve!(comp_model; stepping=(nsteps=5, maxbisec=5), post=post_model)
 
 ## HyperFEM Gallery
 
-
- <p align="center"> 
-&nbsp; &nbsp; &nbsp; &nbsp;
-<img alt="Dark"
-src="https://github.com/MultiSimOLab/HyperFEM/blob/main/docs/imgs/sims_.png?raw=true" width="110%">
-</p>
+<p align="center"><img src="https://github.com/MultiSimOLab/HyperFEM/raw/main/docs/imgs/sims_.png" width="110%"></p>
 
 
 
@@ -160,17 +143,12 @@ C. Perez‐Garcia, R. Ortigosa, J. Martínez‐Frutos, and D. Garcia‐Gonzalez,
 along with the required citations for [Gridap](https://github.com/gridap/Gridap.jl).
 
 
-# Project funded by:
+## Project funded by
 
 - 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"> 
-&nbsp; &nbsp; &nbsp; &nbsp;
-<img alt="Dark"
-src="https://github.com/MultiSimOLab/HyperFEM/blob/main/docs/imgs/aei.png?raw=true" width="70%">
-</p>
-
-#  Contact
+##  Contact
 
-Contact the project administrator [Jesús Martínez-Frutos](jesus.martinez@upct.es) for further questions about licenses and terms of use.
+Contact the project administrator [Jesús Martínez-Frutos](mailto:jesus.martinez@upct.es) for further questions about licenses and terms of use.

docs/Project.toml

@@ -1,3 +1,3 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-Mimosa = "ddbf423a-3df4-409e-9685-3dc416cae46c"
+HyperFEM = "ddbf423a-3df4-409e-9685-3dc416cae46c"

docs/make.jl

@@ -1,25 +1,34 @@
-using HyperFEM
 using Documenter
+using HyperFEM
 
-DocMeta.setdocmeta!(HyperFEM, :DocTestSetup, :(using HyperFEM); recursive=true)
+readme_path = joinpath(@__DIR__, "..", "README.md")
+index_path = joinpath(@__DIR__, "src", "index.md")
+cp(readme_path, index_path, force=true)
 
-makedocs(;
-    modules=[HyperFEM],
-    authors="MultiSimo_Group",
-    repo="https://github.com/jmartfrut/Mimosa.jl/blob/{commit}{path}#{line}",
-    sitename="HyperFEM.jl",
-    format=Documenter.HTML(;
-        prettyurls=get(ENV, "CI", "false") == "true",
-        canonical="https://jmartfrut.github.io/HyperFEM.jl",
-        edit_link="main",
-        assets=String[],
-    ),
-    pages=[
-        "Home" => "index.md",
-    ],
+makedocs(
+  sitename = "HyperFEM.jl",
+  modules = [
+    HyperFEM,
+    HyperFEM.TensorAlgebra,
+    HyperFEM.PhysicalModels,
+    HyperFEM.WeakForms,
+    HyperFEM.Solvers,
+    HyperFEM.DiscreteModeling,
+    HyperFEM.ComputationalModels
+  ],
+  pages = [
+    "HyperFEM" => "index.md",       # Inject README.md (previously cloned into index.md)
+    "API reference" => "api.md"  # Inject the docstrings from the code
+  ],
+  format = Documenter.HTML(
+    prettyurls = get(ENV, "CI", "false") == "true",
+    canonical = "https://MultiSimOLab.github.io/HyperFEM.jl",
+  ),
+  checkdocs = :none,
+  warnonly = true
 )
 
-deploydocs(;
-    repo="github.com/jmartfrut/HyperFEM.jl",
-    devbranch="main",
+deploydocs(
+  repo = "github.com/MultiSimOLab/HyperFEM.jl.git",
+  devbranch = "main"
 )

docs/src/api.md

@@ -0,0 +1,15 @@
+# API reference
+
+```@autodocs
+Modules = [
+  HyperFEM,
+  HyperFEM.TensorAlgebra,
+  HyperFEM.PhysicalModels,
+  HyperFEM.WeakForms,
+  HyperFEM.Solvers,
+  HyperFEM.DiscreteModeling,
+  HyperFEM.ComputationalModels
+]
+Order   = [:module, :type, :function, :macro]
+Public  = true
+```