Chebyshev documentation

[mrhardman]

Addition of documentation of fundamental Chebyshev grid operations.

Please review the notes and give comments! @LucasMontoya4 @johnomotani @mabarnes

[LucasMontoya4]

I'm not sure if I'm just going to the wrong page over and over, but it looks to me like the latest commit is an empty file docs/src/chebyshev.md, so I can't edit the previous commit documentation (which actually has the content)...? Just on the typo side of things. I'll look more closely at the maths now lol

[mrhardman]

I can view the documentation at this link https://github.com/mabarnes/moment_kinetics/blob/chebyshev_documentation/docs/src/chebyshev.md.

…

________________________________ From: Lucas F McConnell Montoya ***@***.***> Sent: 28 July 2024 16:39 To: mabarnes/moment_kinetics ***@***.***> Cc: Michael Hardman ***@***.***>; Author ***@***.***> Subject: Re: [mabarnes/moment_kinetics] Chebyshev documentation (PR #230) I'm not sure if I'm just going to the wrong page over and over, but it looks to me like the latest commit is an empty file docs/src/chebyshev.md, so I can't edit the previous commit documentation (which actually has the content)...? Just on the typo side of things. I'll look more closely at the maths now lol — Reply to this email directly, view it on GitHub<#230 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AHDLPPU66Y65PWJ35J3G7Y3ZOUGCTAVCNFSM6AAAAABLIACHV2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJUGU2TSOBVGM>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[johnomotani]

Still seem to be some bugs in the formatting. If you go into the docs/ subdirectory and, in that directory, do (if I'm remembering right...)

$ julia --project
julia> ]
pkg> dev ../moment_kinetics
pkg> dev ../makie_post_processing
pkg> dev ../plots_post_processing
pkg> <backspace>
julia> include("make.jl")

Then it should build the documentation in docs/build/. You can open docs/build/index.html with a web browser to check the page. If you leave the Julia REPL open, running include("make.jl") will be slow the first time, but fast the second time and afterwards.

[johnomotani]

@LucasMontoya4 if you look at the 'Files changed' tab on the PR page, you can see all the changes, and add comments/suggestions.

[johnomotani]

@mrhardman the link to the preview docs is the one beside the documenter/deploy CI job, which you can follow through to here for the Chebyshev page https://mabarnes.github.io/moment_kinetics/previews/PR230/chebyshev/.

[mrhardman]

@mrhardman the link to the preview docs is the one beside the documenter/deploy CI job, which you can follow through to here for the Chebyshev page https://mabarnes.github.io/moment_kinetics/previews/PR230/chebyshev/.

I seem to have misunderstood the required syntax. This version renders properly https://github.com/mabarnes/moment_kinetics/blob/chebyshev_documentation/docs/src/chebyshev.md Can you tell me where I can find the instructions on syntax? Happy for this to be fixed by search and replace if this is trivial for you.

[mrhardman]

Chebyshev docs should now render correctly @LucasMontoya4 if you want to try and continue your review of these notes at the link suggested by John above https://mabarnes.github.io/moment_kinetics/previews/PR230/chebyshev/. Happy to modify the docs with suggestions before merging.