The documentation update

[April-Hannah-Lena]

As it turns out, writing documentation isn't as fun as writing the code itself haha. But the docs are now set up! There are 8 pages:

• Home: info on how to install
• Getting started: a brief intro to dynamics using the Hénon map as an example
• General usage: a description of how most of the data structures can be used
• Algorithms: gives mathematical background and implementation details for the algorithms found in algorithms.jl
  • finite time Lyapunov exponents is still a TODO. I'm not very familiar with the topic so I left it, instead of writing something completely wrong
  • a description of how invariant measures are found, i.e. a description of the implicitly restarted Arnoldi method could be added
• Maximizing performance:
  • with the CPU
  • with the GPU
• Plotting: A brief description of Makie and how to use plot
• Examples: Links to all example files with descriptions
• Reference: docstrings

Not that some of the docs refer to code that is not yet in GAIO.jl because it will come in the next PR. I just did'nt wat to unnecessarily write some docs twice.

To preview the docs, clone the branch, then use the following in the julia REPL:

julia> pwd()
  "path/to/GAIO.jl"

julia> cd("./docs")

(v1.7) pkg> activate .
  Activating project at `/path/to/GAIO.jl/docs`

(docs) pkg> dev ../
   Resolving package versions...
  No Changes to `/path/to/GAIO.jl/docs/Project.toml`
  No Changes to `/path/to/GAIO.jl/docs/Manifest.toml`

(docs) pkg> instantiate
  69 dependencies successfully precompiled in 74 seconds

julia> using GAIO

julia> using Documenter, LinearAlgebra, SparseArrays

julia> makedocs(
    modules = [GAIO],
    sitename = "GAIO.jl",
    pages = [
        "Home" => "index.md",
        "Getting started" => "getting_started.md",
        "General usage" => "general.md",
        "Algorithms" => "algorithms.md",
        "Maximizing Performance" => [
            "simd.md",
            "cuda.md"
        ],
        "Plotting" => "plotting.md",
        "Examples" => "examples.md",
        "Reference" => [
            "data_structures.md",
            "library_reference.md"
        ]
    ],
    doctest = false
)

 [...]

Once julia has finished building the docs, open a new terminal in the docs/build folder and use python/python3

$ python -m http.server --bind localhost

This will host the docs/build folder that can be opened in the browser.

Finally, I made a cute little plot of the unstable manifold for the Lorenz attractor using the julia logo colors to put on the logo. Which color version do you prefer?

[gaioguy]

Awesome! I also like the logo idea - and definitely prefer the second one (i.e. with red at the outside). I would rather get rid of the axes for the logo, though.