Merge pull request #33 from j-fu/modernize

Modernize: Formatting, fix named using, remove some superfluous files from stl dir, fix for 1.11 memory handling
JuliaGeometry · Nov 15, 2023 · e9934ed · e9934ed · j-fu · Nov 15, 2023
2 parents b7505cf + 181d78e
commit e9934ed
Show file tree

Hide file tree

Showing 19 changed files with 788 additions and 12,921 deletions.
diff --git a/.JuliaFormatter.toml b/.JuliaFormatter.toml
@@ -0,0 +1,6 @@
+style = "sciml"
+pipe_to_function_call=false
+always_for_in = false
+separate_kwargs_with_semicolon = true
+margin = 132
+yas_style_nesting=true
diff --git a/.github/workflows/format_check.yml b/.github/workflows/format_check.yml
@@ -0,0 +1,45 @@
+
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: [1.3.0]
+        julia-arch: [x86]
+        os: [ubuntu-latest]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - uses: actions/checkout@v1
+      - name: Install JuliaFormatter and format
+        # This will use the latest version by default but you can set the version like so:
+        #
+        # julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
+        run: |
+          julia  -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
+          julia  -e 'using JuliaFormatter; format(".", verbose=true)'
+      - name: Format check
+        run: |
+          julia -e '
+          out = Cmd(`git diff --name-only`) |> read |> String
+          if out == ""
+              exit(0)
+          else
+              @error "Some files have not been formatted !!!"
+              write(stdout, out)
+              exit(1)
+          end'
+      
+
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "TetGen"
 uuid = "c5d3f3f7-f850-59f6-8a2e-ffc6dc1317ea"
 authors = ["SimonDanisch <[email protected]>", "Juergen Fuhrmann <[email protected]"]
-version = "1.4.0"
+version = "1.5.0"
 
 [deps]
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
@@ -15,8 +15,8 @@ TetGen_jll = "b47fdcd6-d2c1-58e9-bbba-c1cee8d8c179"
 DocStringExtensions = "0.8,0.9"
 GeometryBasics = "0.2, 0.3, 0.4"
 StaticArrays = "1"
-julia = "1.6"
 TetGen_jll = "1.5.3"
+julia = "1.6"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 TetGen = "c5d3f3f7-f850-59f6-8a2e-ffc6dc1317ea"
+
+[compat]
+Documenter = "1"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,21 +1,20 @@
 using Documenter, TetGen
 
 function make_all()
-    makedocs(
+    makedocs(;
+             sitename = "TetGen.jl",
+             modules = [TetGen],
+             warnonly = true,
+             clean = false,
+             doctest = false,
+             authors = "Simon Danisch, Juergen Fuhrmann",
+             repo = "https://github.com/JuliaGeometry/TetGen.jl",
+             pages = [
+                 "Home" => "index.md",
+             ])
 
-        sitename="TetGen.jl",
-        modules = [TetGen],
-        clean = true,
-        doctest = false,
-        authors = "Simon Danisch, Juergen Fuhrmann",
-        repo="https://github.com/JuliaGeometry/TetGen.jl",
-        pages=[ 
-            "Home"=>"index.md"
-        ]
-    )
-
     if !isinteractive()
-        deploydocs(repo = "github.com/JuliaGeometry/TetGen.jl.git")
+        deploydocs(; repo = "github.com/JuliaGeometry/TetGen.jl.git")
     end
 end
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -25,6 +25,10 @@ Modules = [TetGen]
 Pages = [ "rawtetgenio.jl"]
 ```
 
+```@docs
+tetunsuitable!
+```
+
 
 ## TetGen C++ code