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

New tutorials section #1876

Open
wants to merge 27 commits into
base: master
Choose a base branch
from
Open

Conversation

luisaFelixSalles
Copy link
Collaborator

@luisaFelixSalles luisaFelixSalles commented Nov 7, 2024

This PR add the tutorials section in the documentation

  • Change the user guide index page
  • Create the tutorials section/ topics
  • Add the jupyter_sphinx extension so the tutorials snippets will be executed when the doc is built

Preview on how it renders:

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_index html

@luisaFelixSalles luisaFelixSalles added the documentation Improvements or additions to documentation label Nov 7, 2024
@luisaFelixSalles luisaFelixSalles self-assigned this Nov 7, 2024
Copy link

codecov bot commented Nov 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.11%. Comparing base (ce858d8) to head (576cd9f).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1876   +/-   ##
=======================================
  Coverage   88.11%   88.11%           
=======================================
  Files          83       83           
  Lines        9993     9993           
=======================================
  Hits         8805     8805           
  Misses       1188     1188           

@PProfizi PProfizi added the tutorials Related to PyDPF-Core tutorials label Nov 19, 2024
PProfizi and others added 3 commits November 19, 2024 16:40
* 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]>
luisaFelixSalles and others added 3 commits November 28, 2024 11:04
* 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]>
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 tutorials Related to PyDPF-Core tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants