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

Add Tutorials section to docs #87

Closed
wants to merge 19 commits into from
Closed

Conversation

Cmurilochem
Copy link
Collaborator

@Cmurilochem Cmurilochem commented Sep 19, 2024

As discussed in #84, I am adding a new tutorial section to the docs and will start the translation from the previous Gridap material.

Notes

Similarly to PartitionedArrays.jl, this first attempt uses the Literate package to convert the jl tutorial into a md page.

Closes #85 and closes #86.

@Cmurilochem Cmurilochem marked this pull request as draft September 19, 2024 12:56
@Cmurilochem Cmurilochem added the documentation Improvements or additions to documentation label Sep 19, 2024
@Cmurilochem Cmurilochem self-assigned this Sep 19, 2024
@@ -0,0 +1,58 @@
```@meta
EditURL = "../../poisson_tutorial.jl"
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a auto generated file. It is better to remove it from the repo. Maybe also edit the .gitignore to skip this type of files.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @fverdugo. As suggested, I added the generated tutorials md files to .gitignore.

@Cmurilochem
Copy link
Collaborator Author

@fverdugo. I finally managed to clean up a bit the t001_poisson.ipynb, adding the new plotting functions. Maybe we could discuss today any possible improvements. However, I would like to kindly request you help to edit and possibly add text to it as this would also be important to us to start understand the software internals.

@fverdugo fverdugo mentioned this pull request Oct 20, 2024
@fverdugo fverdugo closed this Oct 20, 2024
@fverdugo
Copy link
Collaborator

PR #122 substitutes this one

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 hp2sim
Projects
None yet
2 participants