Skip to content

Add the 1D wave.jl documentation into example.md #2301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cquiroz1031
Copy link

Adds a new subsection to examples.md containing documentation for the wave.jl 1D wave equation example implemented with ClimaCore.
This documentation is intended to provide a simple, self-contained example for new users of ClimaCore.

  • Code follows the style guidelines OR N/A.
  • Unit tests are included OR N/A.
  • Code is exercised in an integration test OR N/A.
  • Documentation has been added/updated OR N/A.

@valeriabarra valeriabarra self-requested a review April 21, 2025 16:57
@valeriabarra valeriabarra added the documentation Improvements or additions to documentation label Apr 21, 2025
@valeriabarra
Copy link
Member

Hi @cquiroz1031 , thank you for your contribution!

There are a couple of error messages in the doc build. It is recommended that you test the doc build on your local machine before pushing to the PR.

┌ Error: invalid local link/image: path pointing to a file outside of build directory in docs/src/examples.md
│   link =
│    @ast MarkdownAST.Image("../assets/wave_end.png", "") do
│      MarkdownAST.Text("wave_end.png")
│    end
│    
└ @ Documenter ~/.julia/packages/Documenter/tbj1p/src/utilities/utilities.jl:47
┌ Error: invalid local link/image: path pointing to a file outside of build directory in docs/src/examples.md
│   link =
│    @ast MarkdownAST.Image("../assets/wave.gif", "") do
│      MarkdownAST.Text("wave.gif")
│    end
│    
└ @ Documenter ~/.julia/packages/Documenter/tbj1p/src/utilities/utilities.jl:47

To see these error messages, click on the failing GitHub Action check:
image

Try to fix these locally and push to your branch again. Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants