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 guidelines in the main tutorials branch #1950

Open
wants to merge 45 commits into
base: doc/new-tutorials-section
Choose a base branch
from

Conversation

luisaFelixSalles
Copy link
Collaborator

Change the contributing section:

  • Updates on the main page
  • Add section specific for the documentation
  • Add guidelines to write tutorials

luisaFelixSalles and others added 30 commits October 21, 2024 17:38
* Add custom badges for supported solvers

* Test custom badges

* Update conf.py

* Update doc/source/conf.py

Co-authored-by: Revathy Venugopal <[email protected]>

---------

Co-authored-by: Revathy Venugopal <[email protected]>
* add a file with refs and links to be used in the doc

* add a file with refs and links to be used in the doc
* add animate_data.rst tutorial

* completes the animate_data.rst tutorial

* Apply suggestions from code review

Co-authored-by: Paul Profizi <[email protected]>

* codes for just one case and erase badges

* change tutorial name

* last updates

* Update animate_time.rst

* Fixing moving camera

* Apply suggestions from code review

Co-authored-by: Luisa Felix Salles <[email protected]>

* Update doc/source/user_guide/tutorials/animate/animate_time.rst

* Apply suggestions from code review

Co-authored-by: JennaPaikowsky <[email protected]>

* Apply suggestions from code review

Co-authored-by: Luisa Felix Salles <[email protected]>

* Apply suggestions from code review

* Update doc/source/user_guide/tutorials/animate/animate_time.rst

* updates

---------

Co-authored-by: Paul Profizi <[email protected]>
Co-authored-by: PProfizi <[email protected]>
Co-authored-by: JennaPaikowsky <[email protected]>
@luisaFelixSalles luisaFelixSalles added the tutorials Related to PyDPF-Core tutorials label Dec 3, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Dec 3, 2024
Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.06%. Comparing base (e9cfde6) to head (b3654d3).

Additional details and impacted files
@@                    Coverage Diff                     @@
##           doc/new-tutorials-section    #1950   +/-   ##
==========================================================
  Coverage                      88.06%   88.06%           
==========================================================
  Files                             83       83           
  Lines                           9993     9993           
==========================================================
  Hits                            8800     8800           
  Misses                          1193     1193           

Introduction to the tutorial


:jupyter-download-script:`Download tutorial as Python script<file_name>` :jupyter-download-notebook:`Download tutorial as notebook<file_name>`
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
:jupyter-download-script:`Download tutorial as Python script<file_name>` :jupyter-download-notebook:`Download tutorial as notebook<file_name>`
:jupyter-download-script:`Download tutorial as Python script<file_name>` :jupyter-download-notebook:`Download tutorial as Jupyter notebook<file_name>`


Introduction to the tutorial

:jupyter-download-script:`Download tutorial as Python script<file_name>` :jupyter-download-notebook:`Download tutorial as notebook<file_name>`
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggested change
:jupyter-download-script:`Download tutorial as Python script<file_name>` :jupyter-download-notebook:`Download tutorial as notebook<file_name>`
:jupyter-download-script:`Download tutorial as Python script<file_name>` :jupyter-download-notebook:`Download tutorial as Jupyter notebook<file_name>`

@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorials Related to PyDPF-Core tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants