From 0f49d5c744d1500ff67d995bb61c74cc61f601b9 Mon Sep 17 00:00:00 2001 From: EdoAlvarezR Date: Tue, 16 Apr 2024 17:42:44 -0500 Subject: [PATCH] Update docs to be compatible with Julia v1.10.2 --- docs/Project.toml | 4 ++++ docs/README.md | 4 ++-- docs/src/index.md | 3 +-- docs/src/installation/general.md | 16 ++++++++-------- docs/src/installation/windows.md | 8 +++++--- 5 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/Project.toml b/docs/Project.toml index dfa65cd1..de08706c 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,2 +1,6 @@ [deps] Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8" + +[compat] +Documenter = "0.27" diff --git a/docs/README.md b/docs/README.md index 09a0b53c..1ff3a3b5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,10 +1,10 @@ Build docs: -* Install Documenter in Julia: `] add Documenter.jl` +* Install Documenter in Julia: `] add Documenter#v0.27.25` * Compile source files: `julia make.jl`(this will generate html files in `build/` and push/deploy the documentation to GitHub Pages) > You can also manually deploy documentation into the gh-pages branch for -Github Pages: `mkdocs gh-deploy`. You will need to roll jinja2 back to v3.0.3 +Github Pages: `mkdocs gh-deploy`. You will need to roll jinja2 back to v3.0.3 for mkdocs to work: `pip install --force-reinstall -v "jinja2==3.0.3"`. Launching docs page (`build/`) locally: diff --git a/docs/src/index.md b/docs/src/index.md index 48f68bde..5bb049c4 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -237,8 +237,7 @@ See the following publications for an in-depth dive into the theory and validati -**Ducted Fan:** [[Slides](http://edoalvar2.groups.et.byu.net/public/FLOWUnsteady/alvarez_2023-SLIDES-VPM_for_EDF_in_Non_Axisymmetric_Flow.pdf -)] +**Ducted Fan:** [[Slides](http://edoalvar2.groups.et.byu.net/public/FLOWUnsteady/alvarez_2023-SLIDES-VPM_for_EDF_in_Non_Axisymmetric_Flow.pdf)] ```@raw html
diff --git a/docs/src/installation/general.md b/docs/src/installation/general.md index cce22f0d..6192fabc 100644 --- a/docs/src/installation/general.md +++ b/docs/src/installation/general.md @@ -17,8 +17,8 @@ FLOWUnsteady. ## Julia * Download and install Julia: [julialang.org](https://julialang.org/downloads) - (currently we are only supporting up to Julia v1.8.5, so we recommend using - [v1.8.5](https://julialang.org/downloads/oldreleases/) or + (currently we are supporting up to Julia v1.10, so we recommend using + [v1.10.2](https://julialang.org/downloads) or [v1.6.7 LTS](https://julialang.org/downloads/#long_term_support_release) ) * Add Julia to user-level `bin` folder @@ -28,7 +28,7 @@ FLOWUnsteady. Replace `/[user-specific-path/Julia-1.x.x]/` with the path where Julia got installed. For instance, in MacOS the full path looks like this: - `/Applications/Julia-1.8.app/Contents/Resources/julia/bin/julia` + `/Applications/Julia-1.10.app/Contents/Resources/julia/bin/julia` If you were successfull, typing the following in the terminal will launch the Julia REPL: @@ -47,7 +47,7 @@ julia Replace `/[user-specific-path/ParaView-5.x.x]/` with the path where ParaView got installed. For instance, in MacOS the full path looks like this: - `/Applications/ParaView-5.11.0.app/Contents/MacOS/paraview` + `/Applications/ParaView-5.12.0.app/Contents/MacOS/paraview` If you were successfull, typing the following in the terminal will launch the ParaView: @@ -136,7 +136,7 @@ first you will have to install FLOWExaFMM and compile ExaFMM, as follows. * *[Julia REPL]* Install CxxWrap: ```julia import Pkg - Pkg.add(name="CxxWrap", version="0.11.2") + Pkg.add(name="CxxWrap", version="0.15.0") ``` * *[Terminal]* Clone FLOWExaFMM: @@ -175,7 +175,7 @@ add FLOWVPM: ```julia ] test FLOWExaFMM ``` - This will return a heart-warming "Hello world!" if ExaFMM was correctly compiled. + If ExaFMM was correctly compiled, this will return a heart-warming "Hello world!" * Add FLOWVPM: @@ -219,8 +219,8 @@ import Pkg url = "https://github.com/byuflowlab/" -packages = (("AirfoilPrep.jl", "v2.1.2"), ("FLOWVLM", "v2.1.2"), - ("BPM.jl", "v2.0.1"), ("FLOWNoise", "v2.3.2")) +packages = [ ("AirfoilPrep.jl", "v2.1.2"), ("FLOWVLM", "v2.1.2"), + ("FLOWNoise", "v2.3.3"), ("BPM.jl", "v2.0.1") ] Pkg.add([ Pkg.PackageSpec(; url=url*name, rev=v) for (name, v) in packages ]) ``` diff --git a/docs/src/installation/windows.md b/docs/src/installation/windows.md index 34906dfb..a68a2606 100644 --- a/docs/src/installation/windows.md +++ b/docs/src/installation/windows.md @@ -33,9 +33,11 @@ Once inside WSL, do the following ``` ## Install Julia +Still inside WSL, + * Download Julia: ```bash - wget -O julia.tar.gz "https://julialang-s3.julialang.org/bin/linux/x64/1.8/julia-1.8.5-linux-x86_64.tar.gz" + wget -O julia.tar.gz "https://julialang-s3.julialang.org/bin/linux/x64/1.10/julia-1.10.2-linux-x86_64.tar.gz" ``` * Decompress Julia: ```bash @@ -43,7 +45,7 @@ Once inside WSL, do the following ``` * Add Julia to user-level path: ```bash - sudo ln -s ~/Programs/julia-1.8.5/bin/julia /usr/local/bin/ + sudo ln -s ~/Programs/julia-1.10.2/bin/julia /usr/local/bin/ ``` ## Install ParaView @@ -64,4 +66,4 @@ Once inside WSL, do the following --- **Now you can proceed with [the general instructions](@ref installation)** -(you can skip the Julia and ParaView since we already took care of that) +(you can skip the Julia and ParaView instructions since we already took care of that)