Move images

ufechner7 · Dec 13, 2023 · 9edec72 · 9edec72
1 parent d125b01
commit 9edec72
Show file tree

Hide file tree

Showing 13 changed files with 60 additions and 13 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -0,0 +1,34 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+    tags: ['*']
+  pull_request:
+  workflow_dispatch:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 40
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      - run: |
+          julia --project=docs -e '
+            using Documenter: DocMeta, doctest
+            using PkgHelpers
+            DocMeta.setdocmeta!(PkgHelpers, :DocTestSetup, :(using PkgHelpers); recursive=true)
+            doctest(PkgHelpers)'
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,7 @@ bin/kps-image-1.10.so
 .CondaPkg
 src/__pycache__
 .vscode/settings.json
-docs/build
+docs/build/
+docs/src/src
+docs/src/docs
+docs/src/docs/src
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ drag attached.
 ## Installation
 
 1. make sure you are running a `bash` terminal (shell) and you have at least 16GB RAM (MAC, Linux and Windows supported).  
-   On Windows, you can use [git for windows](https://gitforwindows.org/) which provides git AND a bash shell, but for using Julia from a `bash` terminal you must also install either  [Installation and usage of VSCode](docs/vscode.md) or [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install). `Windows Terminal` is the simple and clean solution, `VSCode` the comfortable, fancy solution.
+   On Windows, you can use [git for windows](https://gitforwindows.org/) which provides git AND a bash shell, but for using Julia from a `bash` terminal you must also install either  [Installation and usage of VSCode](docs/images/vscode.md) or [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install). `Windows Terminal` is the simple and clean solution, `VSCode` the comfortable, fancy solution.
 2. install Julia 1.10 using `juliaup`, see [https://github.com/JuliaLang/juliaup](https://github.com/JuliaLang/juliaup). If `juliaup` is already installed, the following commands will do:
 ```
 juliaup add 1.10
@@ -39,7 +39,7 @@ include("src/Tether_01.jl")
 ```
 You should see a plot similar to:
 
-![Falling mass](docs/FallingMass.png)
+![Falling mass](docs/images/FallingMass.png)
 
 This example shows a mass that is thrown upwards, slows down and then falls.
 
@@ -89,7 +89,7 @@ From the Julia prompt, run the simulation:
 ```julia
 include("src/Tether_02.jl")
 ```
-![Spring damper](docs/SpringDamper.png)
+![Spring damper](docs/images/SpringDamper.png)
 
 Mass, attached to a spring damper element. One end of the spring at the origin, the second end
 attached to the mass. Mass initially below the origin, spring un-stretched. Z-axis pointing
@@ -101,7 +101,7 @@ upwards.
 ```julia
 include("src/Tether_03.jl")
 ```
-![Non-linear Spring damper](docs/Nonlinear.png)
+![Non-linear Spring damper](docs/images/Nonlinear.png)
 
 Mass, attached to a spring damper element. One end of the spring at the origin, the second end
 attached to the mass. Mass initially below the origin, spring un-stretched. Z-axis pointing
@@ -219,7 +219,7 @@ We loop backwards over the particles, starting with the last particle, because o
 
 Finally in this example we plot the result dynamically as 2D video. Screenshot:
 
-![Tether 2D](docs/Tether2d.png)
+![Tether 2D](docs/images/Tether2d.png)
 
 
 #### Benchmarking

diff --git a/docs/FallingMass.png → docs/images/FallingMass.png b/docs/FallingMass.png → docs/images/FallingMass.png
diff --git a/docs/Nonlinear.png → docs/images/Nonlinear.png b/docs/Nonlinear.png → docs/images/Nonlinear.png
diff --git a/docs/SpringDamper.png → docs/images/SpringDamper.png b/docs/SpringDamper.png → docs/images/SpringDamper.png
diff --git a/docs/Tether2d.png → docs/images/Tether2d.png b/docs/Tether2d.png → docs/images/Tether2d.png
diff --git a/docs/vscode.md → docs/images/vscode.md b/docs/vscode.md → docs/images/vscode.md
diff --git a/docs/vscode.png → docs/images/vscode.png b/docs/vscode.png → docs/images/vscode.png
diff --git a/docs/make.jl b/docs/make.jl
@@ -6,6 +6,15 @@ if ("TestEnv" ∈ keys(Pkg.project().dependencies))
 end
 using Documenter: deploydocs, makedocs
 
+src="src"
+dst="docs/src/src"
+mkpath(dst)
+cp(src, dst; force=true)
+src="docs/images"
+dst="docs/src/docs/images"
+mkpath(dst)
+cp(src, dst; force=true)
+
 src="README.md"
 dst="docs/src/index.md"
 if ! isfile(dst)

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -7,7 +7,7 @@ drag attached.
 ## Installation
 
 1. make sure you are running a `bash` terminal (shell) and you have at least 16GB RAM (MAC, Linux and Windows supported).  
-   On Windows, you can use [git for windows](https://gitforwindows.org/) which provides git AND a bash shell, but for using Julia from a `bash` terminal you must also install either  [Installation and usage of VSCode](docs/vscode.md) or [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install). `Windows Terminal` is the simple and clean solution, `VSCode` the comfortable, fancy solution.
+   On Windows, you can use [git for windows](https://gitforwindows.org/) which provides git AND a bash shell, but for using Julia from a `bash` terminal you must also install either  [Installation and usage of VSCode](docs/images/vscode.md) or [Windows Terminal](https://learn.microsoft.com/en-us/windows/terminal/install). `Windows Terminal` is the simple and clean solution, `VSCode` the comfortable, fancy solution.
 2. install Julia 1.10 using `juliaup`, see [https://github.com/JuliaLang/juliaup](https://github.com/JuliaLang/juliaup). If `juliaup` is already installed, the following commands will do:
 ```
 juliaup add 1.10
@@ -39,7 +39,7 @@ include("src/Tether_01.jl")
 ```
 You should see a plot similar to:
 
-![Falling mass](docs/FallingMass.png)
+![Falling mass](docs/images/FallingMass.png)
 
 This example shows a mass that is thrown upwards, slows down and then falls.
 
@@ -89,7 +89,7 @@ From the Julia prompt, run the simulation:
 ```julia
 include("src/Tether_02.jl")
 ```
-![Spring damper](docs/SpringDamper.png)
+![Spring damper](docs/images/SpringDamper.png)
 
 Mass, attached to a spring damper element. One end of the spring at the origin, the second end
 attached to the mass. Mass initially below the origin, spring un-stretched. Z-axis pointing
@@ -101,7 +101,7 @@ upwards.
 ```julia
 include("src/Tether_03.jl")
 ```
-![Non-linear Spring damper](docs/Nonlinear.png)
+![Non-linear Spring damper](docs/images/Nonlinear.png)
 
 Mass, attached to a spring damper element. One end of the spring at the origin, the second end
 attached to the mass. Mass initially below the origin, spring un-stretched. Z-axis pointing
@@ -219,7 +219,7 @@ We loop backwards over the particles, starting with the last particle, because o
 
 Finally in this example we plot the result dynamically as 2D video. Screenshot:
 
-![Tether 2D](docs/Tether2d.png)
+![Tether 2D](docs/images/Tether2d.png)
 
 
 #### Benchmarking

diff --git a/docs/src/python.md b/docs/src/python.md
@@ -1,2 +1 @@
-## Python and Julia in harmonie
-
+## Python and Julia in harmony
diff --git a/src/Tethers.jl b/src/Tethers.jl
@@ -0,0 +1,2 @@
+module Tethers
+end