Skip to content

Add Python code for couple your code section#523

Merged
uekerman merged 4 commits intoprecice:masterfrom
kss682:extend-codes-with-tabs
Jun 3, 2025
Merged

Add Python code for couple your code section#523
uekerman merged 4 commits intoprecice:masterfrom
kss682:extend-codes-with-tabs

Conversation

@kss682
Copy link
Copy Markdown
Collaborator

@kss682 kss682 commented Apr 25, 2025

This PR implements the discussions of #211.

Add Python code examples for the couple your code section using nav tabs.

@kss682 kss682 force-pushed the extend-codes-with-tabs branch from f5e0cac to 80aabc0 Compare April 27, 2025 22:07
@kss682
Copy link
Copy Markdown
Collaborator Author

kss682 commented Apr 27, 2025

@uekerman
Could you please check if the python doc until meshes are as expected ?

Copy link
Copy Markdown
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

Looks good in principle. No need to also cover inline code. The code blocks are enough. And not need to bring the docstrings.

Be careful with details. The code should really run. Maybe test with a dummy on the side to be completely sure.

Where do the css changes come from? I am not saying that they don't make sense, I only want to understand better. Could you maybe add screenshots before and after?

I did not try to build the website.

You also pushed to #211. No need to update both. You could close #211 in favor of this one.

Comment thread pages/docs/couple-your-code/couple-your-code-steering-methods.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-steering-methods.md
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-mesh-and-data-access.md Outdated
@kss682
Copy link
Copy Markdown
Collaborator Author

kss682 commented Apr 29, 2025

The css changes are from one of the commits from the original PR.
The css adds a box like feel and a background color for the nav tabs.
Curr
image

New
image

@kss682 kss682 force-pushed the extend-codes-with-tabs branch from 80aabc0 to df9b3cb Compare May 11, 2025 21:22
@kss682 kss682 requested a review from uekerman May 11, 2025 21:26
Copy link
Copy Markdown
Member

@uekerman uekerman left a comment

Choose a reason for hiding this comment

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

Good job. A few minor tweaks and fixes below.

Good that you also caught a few missing v2-v3 updates as well 👍

I did not try building the website. Did you check that everything looks good?

Comment thread pages/docs/couple-your-code/couple-your-code-defining-mesh-connectivity.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-defining-mesh-connectivity.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-gradient-data.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-implicit-coupling.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-implicit-coupling.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-time-step-sizes.md
Comment thread pages/docs/couple-your-code/couple-your-code-time-step-sizes.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-time-step-sizes.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-time-step-sizes.md Outdated
Comment thread pages/docs/couple-your-code/couple-your-code-time-step-sizes.md Outdated
@kss682 kss682 force-pushed the extend-codes-with-tabs branch from df9b3cb to 31e934a Compare May 14, 2025 08:31
@kss682
Copy link
Copy Markdown
Collaborator Author

kss682 commented May 14, 2025

I did build the site locally and the rendering looks like this.
image
image

@kss682 kss682 requested a review from uekerman May 14, 2025 08:39
@kss682 kss682 changed the title [WIP] Add Python code for couple your code section Add Python code for couple your code section May 14, 2025
@uekerman
Copy link
Copy Markdown
Member

In my taste, the vertical margins before and after the code are a bit large. Could we decrease those?

@kss682
Copy link
Copy Markdown
Collaborator Author

kss682 commented May 16, 2025

image
image

How does this look ?
Reduced the vertical padding to 4px.

@uekerman uekerman merged commit 7e96c5a into precice:master Jun 3, 2025
2 checks passed
@uekerman
Copy link
Copy Markdown
Member

uekerman commented Jun 3, 2025

@kss682 Please open an issue (and/or investigate) to improve the PDF export, as discussed here: #211 (comment)

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.

3 participants