Skip to content

Conversation

RobPasMue
Copy link
Member

Closes #595

@RobPasMue RobPasMue requested a review from a team May 9, 2025 13:12
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels May 9, 2025
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

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

LGTM. @RobPasMue would it be worth adding a bit of content about creating examples with jupytext since you are updating the documentation on examples ? If you want I can add that in a follow-up, in this PR or not at all :D

@RobPasMue
Copy link
Member Author

Please add it to this PR! That would be super useful -- would you mind adding it?

@SMoraisAnsys
Copy link
Contributor

@RobPasMue I've added content for the Jupytext approach. Let me know if it needs to be updated :)

Copy link
Member Author

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

Left some comments -- all good apart from that

Copy link
Contributor

@clatapie clatapie left a comment

Choose a reason for hiding this comment

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

I left a few comments, other than that: it looks good to me, thanks @RobPasMue!

@RobPasMue RobPasMue merged commit ca084d8 into main May 17, 2025
8 checks passed
@RobPasMue RobPasMue deleted the feat/example-contribution branch May 17, 2025 11:38
github-actions bot pushed a commit that referenced this pull request May 17, 2025
* feat: facilitating example contribution

* feat: enhancements

* Update doc/source/how-to/documenting.rst

Co-authored-by: Kerry McAdams <[email protected]>

* docs: extend with jupytext approach

* fix(docs): wrong link for pyspeos

* Apply suggestions from code review

Co-authored-by: Roberto Pastor Muela <[email protected]>

* refactor: use links file

* Update doc/source/how-to/documenting.rst

Co-authored-by: Camille Latapie <[email protected]>

* Update doc/source/how-to/documenting.rst

* Update doc/source/how-to/documenting.rst

---------

Co-authored-by: Kerry McAdams <[email protected]>
Co-authored-by: Sebastien Morais <[email protected]>
Co-authored-by: Sébastien Morais <[email protected]>
Co-authored-by: Camille Latapie <[email protected]>
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 enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding single-example target and facilitating example contribution
5 participants