chore: format Mantis

.JuliaFormatter.toml

@@ -10,9 +10,9 @@ conditional_to_if = true
 # Add whitespace to type definitions.
 whitespace_typedefs = true
 # Enables formatting for code blocks
-format_docstrings = false
+format_docstrings = true
 # Enables formatting for markdown
-format_markdown = false
+format_markdown = true
 # Stops pipes from being converted to function calls
 pipe_to_function_call = false
 # Since the `formart_markdown` can break markdown blocks in the docs, it is best to ignore

.github/ISSUE_TEMPLATE/bug_report.md

@@ -8,24 +8,31 @@ assignees: ''
 ---
 
 ### First checks
-1. Make sure the bug is from the `Mantis` code and not other modifications.
-2. Check the open issues to see if someone else has already spotted the same bug.
+
+ 1. Make sure the bug is from the `Mantis` code and not other modifications.
+ 2. Check the open issues to see if someone else has already spotted the same bug.
 
 ### Expected behaviour
+
 A clear and concise description of what you expected to happen.
 
 ### Observed behaviour
+
 Prints of the output you obtain.
 
 ### Describe the bug
+
 A clear and concise description of what the bug is.
 
 ### To Reproduce
-1. Indicate the `Mantis` release used.
-2. Provide the minimal but necessary code to encounter the error.
+
+ 1. Indicate the `Mantis` release used.
+ 2. Provide the minimal but necessary code to encounter the error.
 
 ### Screenshots
+
 If applicable, add screenshots to help explain your problem.
 
 ### Additional context
+
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -8,13 +8,17 @@ assignees: ''
 ---
 
 ### Is your feature request related to a problem? Please describe.
+
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 
 ### Describe the solution you'd like
+
 A clear and concise description of what you want to happen.
 
 ### Describe alternatives you've considered
+
 A clear and concise description of any alternative solutions or features you've considered.
 
 ### Additional context
+
 Add any other context or screenshots about the feature request here.

.github/workflows/JuliaFormatter.yml

@@ -0,0 +1,23 @@
+name: Validate Formatting
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+  validate-formatting:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      pull-requests: read
+
+    steps:
+      - uses: actions/checkout@v7
+      - uses: julia-actions/setup-julia@v3
+      - uses: julia-actions/cache@v3
+      - name: Install jlfmt and check formatting
+        run: |
+          export PATH="$HOME/.julia/bin:$PATH"
+          julia -e 'using Pkg; Pkg.Registry.add("General"); Pkg.Registry.update(); Pkg.Apps.add(["JuliaFormatter"])'
+          jlfmt --check -v ./

ACKNOWLEDGMENTS.md

@@ -1,34 +1,36 @@
 # Acknowledgments
 
-## Founders 
+## Founders
 
-- Diogo C. Cabanas
-- Joey Dekker
-- Artur Palha
-- Deepesh Toshniwal
+  - Diogo C. Cabanas
+  - Joey Dekker
+  - Artur Palha
+  - Deepesh Toshniwal
 
 ## Current Maintainers
 
-- Diogo C. Cabanas
-- Joey Dekker
-- Artur Palha
-- Deepesh Toshniwal
+  - Diogo C. Cabanas
+  - Joey Dekker
+  - Artur Palha
+  - Deepesh Toshniwal
 
 All current maintainers are part of TU Delft's Numerical Analysis' department, and therefore
 would like to thank the support the university provides.
 
 Diogo C. Cabanas is supported by FCT - Fundação para a Ciência e Tecnologia, I.P., with
-project reference 2023.00238.BD and DOI identifier https://doi.org/10.54499/2023.00238.BD. 
+project reference 2023.00238.BD and DOI identifier https://doi.org/10.54499/2023.00238.BD.
 
 The research of Deepesh Toshniwal was partially supported (2021-2025) by project number
 202.150 awarded through the Veni research programme by the Dutch Research Council (NWO).
 
 # Previous Contributors
+
 The following TU Delft 'Computer Science and Engineering'-minor students created the first
 implementation of the `TimeIntegrators`-module in Q2/3 of AY2024/2025:
-- Daisy de Blom,
-- Wiktor Cupiał,
-- Pelle Mutsaers,
-- Pablo Raichs Fernandez,
-- Teun Schuurs,
-- Aleksandra Taneva.
+
+  - Daisy de Blom,
+  - Wiktor Cupiał,
+  - Pelle Mutsaers,
+  - Pablo Raichs Fernandez,
+  - Teun Schuurs,
+  - Aleksandra Taneva.

README.md

@@ -27,12 +27,13 @@ and adaptively-refinable spaces (e.g., hierarchical B-splines).
 `Mantis` is free, open-source, and available under the
 [EUPL licence](https://github.com/MantisFEM/Mantis.jl/blob/main/LICENSE).
 
-
 ## Authors
+
 The `Mantis` package was created by
-- Diogo C. Cabanas,
-- Joey Dekker,
-- Artur Palha,
-- Deepesh Toshniwal,
-
+
+  - Diogo C. Cabanas,
+  - Joey Dekker,
+  - Artur Palha,
+  - Deepesh Toshniwal,
+
 from TU Delft's Institute of Applied Mathematics (DIAM).

docs/make.jl

@@ -36,25 +36,24 @@ Design = [
     joinpath("Design", "DesignIntroduction.md"),
     "Philosophy" => [joinpath("Design", "Philosophy", "WhyMantis.md")],
     "Theory" => joinpath.("Design", "Theory", ["FEM.md", "DifferentialForms.md"]),
-    "Modules" =>
-        joinpath.(
-            "Design",
-            "Modules",
-            [
-                "Analysis.md",
-                "Assemblers.md",
-                "Forms.md",
-                "FunctionSpaces.md",
-                "GeneralHelpers.md",
-				"Hierarchy.md",
-                "Geometry.md",
-                "Mesh.md",
-                "Plot.md",
-                "Points.md",
-                "Quadrature.md",
-                "TimeIntegrators.md",
-            ],
-        ),
+    "Modules" => joinpath.(
+        "Design",
+        "Modules",
+        [
+            "Analysis.md",
+            "Assemblers.md",
+            "Forms.md",
+            "FunctionSpaces.md",
+            "GeneralHelpers.md",
+            "Hierarchy.md",
+            "Geometry.md",
+            "Mesh.md",
+            "Plot.md",
+            "Points.md",
+            "Quadrature.md",
+            "TimeIntegrators.md",
+        ],
+    ),
 ]
 
 Support = [
@@ -119,14 +118,14 @@ makedocs(;
     pages=Pages,
     plugins=[bib],
     format=DocumenterVitepress.MarkdownVitepress(;
-        repo="github.com/MantisFEM/Mantis.jl", devbranch = "dev", devurl = "dev"
+        repo="github.com/MantisFEM/Mantis.jl", devbranch="dev", devurl="dev"
     ),
 )
 DocumenterVitepress.deploydocs(;
     repo="github.com/MantisFEM/Mantis.jl",
     target="build", # this is where Vitepress stores its output
     devbranch="dev",
-    devurl = "dev",
+    devurl="dev",
     branch="gh-pages",
     push_preview=true,
 )

docs/src/BibliographicInformation/HowToCite.md

@@ -2,6 +2,7 @@
 
 Thank you for using `Mantis`. Please consider including a citation using Zenodo
 [Cabanas2026](@cite):
+
 ```@bibliography
 Pages = ["HowToCite.md"]
 Canonical = false

docs/src/Design/DesignIntroduction.md

@@ -1,7 +1,8 @@
 # [Introduction](@id DesignIntroduction)
-In this part of the documentation, we provide a detailed description of the ideas and design 
-behind `Mantis`. In the philosophy section, we describe the ideas and philosophy behind 
-`Mantis`, and we discuss why `Mantis` was created. Then, in the theory section, we briefly 
-recap some of the main theoretical ideas that are used within `Mantis`, such as the 
-[The Finite Element Method](@ref). Lastly, in the module section, we describe, per module, 
+
+In this part of the documentation, we provide a detailed description of the ideas and design
+behind `Mantis`. In the philosophy section, we describe the ideas and philosophy behind
+`Mantis`, and we discuss why `Mantis` was created. Then, in the theory section, we briefly
+recap some of the main theoretical ideas that are used within `Mantis`, such as the
+[The Finite Element Method](@ref). Lastly, in the module section, we describe, per module,
 what is available in `Mantis`, its structure, and some of the design choices.

docs/src/Design/Modules/Analysis.md

@@ -1,6 +1,7 @@
 # Analysis
 
 ## All docstrings from Mantis.Analysis
+
 ```@autodocs
 Modules = [Mantis.Analysis]
 ```

docs/src/Design/Modules/Assemblers.md

@@ -1,6 +1,7 @@
 # [Assemblers](@id DocAssemblyModule)
 
 ## All docstrings from Mantis.Assemblers
+
 ```@autodocs
 Modules = [Mantis.Assemblers]
 ```