Skip to content
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

Examples #122

Merged
merged 30 commits into from
Oct 30, 2024
Merged

Examples #122

merged 30 commits into from
Oct 30, 2024

Conversation

fverdugo
Copy link
Collaborator

@fverdugo fverdugo commented Oct 18, 2024

  • Add a basic skeleton for the documentation, including, Examples, Manual, and Reference.
  • Add a first example to set the tone/style for the examples. (These will be short examples, instead of full Tutorials). For the great details we will have the Manual and the docstrings in Reference.

This makes PR #87 obsolete.

cc @Cmurilochem @raar1

@fverdugo
Copy link
Collaborator Author

@Cmurilochem Can you please fix the docs build? I did not manage to get GLMakie working on GH Actions. It works on my computer though.

@Cmurilochem
Copy link
Collaborator

@Cmurilochem Can you please fix the docs build? I did not manage to get GLMakie working on GH Actions. It works on my computer though.

Hi @fverdugo. Thanks for the ideas put into this PR; doc structure looks amazing and it worked locally here also for me. I will have a look at it today.

@fverdugo
Copy link
Collaborator Author

This seems to be a hard one. Have you tried this?

https://discourse.julialang.org/t/ci-fails-to-build-glmakie-dependency/80125/4

@Cmurilochem
Copy link
Collaborator

This seems to be a hard one. Have you tried this?

https://discourse.julialang.org/t/ci-fails-to-build-glmakie-dependency/80125/4

Thanks @fverdugo. Yes, I was actually trying to adapt the solution provided in the above link. I will try once again this morning. The GitHub action runners look strangely "lazy" today or maybe I made a mistake in the file I still did not realize.

@fverdugo
Copy link
Collaborator Author

Hi @Cmurilochem the error in the examples is bc we published a new version in partitioned solvers. Add a compat entry in the project file of the examples to use PartitionedSolvers v0.2,0.

@Cmurilochem
Copy link
Collaborator

Hi @Cmurilochem the error in the examples is bc we published a new version in partitioned solvers. Add a compat entry in the project file of the examples to use PartitionedSolvers v0.2,0.

Thanks @fverdugo for letting me know. I will take care of this. Also, the doc is working with a hack and I will now clean up a bit.

@Cmurilochem
Copy link
Collaborator

@fverdugo. I will take this task as done. I decided to build the docs via include(docs/make.jl) instead of using julia-actions/julia-docdeploy. See you later this afternoon.

@fverdugo fverdugo merged commit cb11c83 into main Oct 30, 2024
4 checks passed
@fverdugo fverdugo deleted the examples branch October 30, 2024 12:26
@Cmurilochem Cmurilochem mentioned this pull request Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants