Merge pull request #21 from JuliaGeometry/jf/docs-reorg

Jf/docs reorg

Author: j-fu

.codespellrc

@@ -0,0 +1,2 @@
+[codespell]
+ignore-words-list = Missings

.github/workflows/ci.yml

@@ -15,24 +15,34 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.6' # Replace this with the minimum Julia version that your package supports. E.g. if your package requires Julia 1.5 or higher, change this to '1.5'.
+          - 'lts' # Replace this with the minimum Julia version that your package supports. E.g. if your package requires Julia 1.5 or higher, change this to '1.5'.
           - '1'   # Leave this line unchanged. '1' will automatically expand to the latest stable 1.x release of Julia.
           - 'nightly'
         os:
           - ubuntu-latest
-          - macos-latest
           - windows-latest
+          - macOS-13 # intel
+          - macOS-14 # arm
         arch:
           - x64
+          - aarch64
+        exclude:
+          - os: ubuntu-latest
+            arch: aarch64
+          - os: windows-latest
+            arch: aarch64
+          - os: macOS-13
+            arch: aarch64
+          - os: macOS-14
+            arch: x64
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      - uses: julia-actions/cache@v2
+      - uses: actions/cache@v4
         env:
-          PYTHON: ""
           cache-name: cache-artifacts
         with:
           path: ~/.julia/artifacts
@@ -42,17 +52,22 @@ jobs:
             ${{ runner.os }}-test-
             ${{ runner.os }}-
       - uses: julia-actions/julia-buildpkg@v1
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
       - uses: julia-actions/julia-runtest@v1
+        # env:
+        #   JULIA_NUM_THREADS: 4
       - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v1
-        with:
-          file: lcov.info
+      - uses: codecov/codecov-action@v5
   docs:
     name: Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
           version: '1'
       - run: |
@@ -67,7 +82,5 @@ jobs:
       #       doctest(MYPACKAGE)'
       - run: julia --project=docs docs/make.jl
         env:
-          PYTHON: ""
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-          

.github/workflows/format_check.yml

@@ -0,0 +1,22 @@
+name: code quality checks
+
+on:
+  pull_request:
+
+jobs:
+  pre-commit:
+    name: run pre-commit
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: julia-actions/setup-julia@v2
+      with:
+        version: 1
+    - run: |
+          julia --project=@runic -e '
+            using Pkg
+            Pkg.add("Runic")'
+      env:
+        PYTHON: ""
+    - uses: actions/setup-python@v5
+    - uses: pre-commit/[email protected]

.github/workflows/pre-commit.yml

@@ -7,4 +7,3 @@ Manifest.toml
 deps/build.log
 deps/deps.jl
 deps/usr
-

.gitignore

@@ -0,0 +1,25 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: check-added-large-files
+    args: [--maxkb=8192]
+  - id: check-merge-conflict
+  - id: check-toml
+  - id: check-yaml
+    args: [--allow-multiple-documents]
+  - id: end-of-file-fixer
+  - id: no-commit-to-branch
+    args: [--branch,master]
+- repo: https://github.com/gitleaks/gitleaks
+  rev: v8.16.3
+  hooks:
+  - id: gitleaks
+- repo: https://github.com/fredrikekre/runic-pre-commit
+  rev: v1.0.0
+  hooks:
+  - id: runic
+# - repo: https://github.com/codespell-project/codespell
+#   rev: v2.2.4
+#   hooks:
+#   - id: codespell

.pre-commit-config.yaml

@@ -7,7 +7,7 @@
 - JuliaFormatter
 
 ## v2.2.0 Oct 10, 2022
-- Fix ReadOnlyMemoryError occuring sometimes on windows for Julia <=1.8 and consistently for 1.9
+- Fix ReadOnlyMemoryError occurring sometimes on windows for Julia <=1.8 and consistently for 1.9
 - New upstream repo for Triangle c source: https://github.com/JuliaGeometry/Triangle
 
 ## v2.1.0  Oct 7, 2021

CHANGELOG.md

@@ -4,6 +4,7 @@ Triangulate
 [![Build status](https://github.com/JuliaGeometry/Triangulate.jl/workflows/linux-macos-windows/badge.svg)](https://github.com/JuliaGeometry/Triangulate.jl/actions)
 [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliageometry.github.io/Triangulate.jl/stable)
 [![PkgEval](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/T/Triangulate.svg)](https://juliaci.github.io/NanosoldierReports/pkgeval_badges/report.html)
+[![code style: runic](https://img.shields.io/badge/code_style-%E1%9A%B1%E1%9A%A2%E1%9A%BE%E1%9B%81%E1%9A%B2-black)](https://github.com/fredrikekre/Runic.jl)
 
 Julia wrapper for Jonathan Richard Shewchuk's Triangle mesh generator. The package tries to provide a 1:1 mapping of Triangle's functionality to Julia.
 
@@ -40,5 +41,3 @@ free, then you are not required to make any arrangement with me.)
 ## Acknowledgement
 This package uses ideas from  [TriangleMesh.jl](https://github.com/konsim83/TriangleMesh.jl)
 and [Triangle.jl](https://github.com/cvdlab/Triangle.jl).
-
-

README.md

@@ -7,7 +7,7 @@ function rendernotebook(name)
     ENV["PLUTO_PROJECT"] = joinpath(@__DIR__, "..", "examples")
     notebook = Pluto.SessionActions.open(session, input; run_async = false)
     html_contents = Pluto.generate_html(notebook)
-    write(output, html_contents)
+    return write(output, html_contents)
 end
 
 function make_all()
@@ -17,19 +17,23 @@ function make_all()
     rendernotebook("pluto-examples")
     Pkg.activate(@__DIR__)
 
-    makedocs(; sitename = "Triangulate.jl",
-             modules = [Triangulate],
-             clean = false,
-             doctest = false,
-             authors = "Juergen Fuhrmann, Francesco Furiani, Konrad Simon",
-             repo = "https://github.com/JuliaGeometry/Triangulate.jl",
-             pages = ["Home" => "index.md",
-                 "triangle-h.md",
-                 "Major changes" => "changes.md",
-                 "allindex.md",
-                 "examples.md"])
+    makedocs(;
+        sitename = "Triangulate.jl",
+        modules = [Triangulate],
+        clean = false,
+        doctest = false,
+        authors = "Juergen Fuhrmann, Francesco Furiani, Konrad Simon",
+        repo = "https://github.com/JuliaGeometry/Triangulate.jl",
+        pages = [
+            "Home" => "index.md",
+            "triangle-h.md",
+            "Major changes" => "changes.md",
+            "allindex.md",
+            "examples.md",
+        ]
+    )
 
-    if !isinteractive()
+    return if !isinteractive()
         deploydocs(; repo = "github.com/JuliaGeometry/Triangulate.jl.git")
     end
 end

docs/make.jl

@@ -5,6 +5,3 @@ Generated from the Pluto notebook [pluto-examples.jl](https://github.com/JuliaGe
 ```@raw html
 <iframe style="height:15000px" width="100%" src="../pluto-examples.html"> </iframe>
 ```
-
-
-

docs/src/examples.md

@@ -38,4 +38,3 @@ of Triangle.
 Modules = [Triangulate]
 Pages = [ "triangulateio.jl", "plot.jl"]
 ```
-