New tutorials section #1876
Open
New tutorials section #1876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
luisaFelixSalles
added
the
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1876 +/- ##
==========================================
+ Coverage 88.42% 88.48% +0.06%
==========================================
Files 89 89
Lines 10251 10251
==========================================
+ Hits 9064 9071 +7
+ Misses 1187 1180 -7 |
15 tasks
PProfizi
reviewed
Nov 19, 2024
luisaFelixSalles
commented
Dec 4, 2024
* 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
force-pushed
the
doc/new-tutorials-section
branch
from
576cd9f to
627c2de
Compare
* add new basic tutorial and jupyter_ sphinx extension * separate the documentation part from the contributing.rst (main page) * create the index page for the writing documentation section * add the tutorials guide lines file * add the tutorial template file * updates the contributing.rst main page * add a separate section for develop code (contributing) * add the writing documentation index page * add new links to links_and_refs.rst * add tutorial_card_template.rst * add tutorial_section_template.rst * add toctree to index file of the write_doc folder * add first part of the guide_lines_tutorials.rst * updates * final first version of guide_lines_tutorials.rst * add tutorial_content_template.rst * add tutorial_structure_template.rst * updates the guide_lines_tutorials.rst with the new tutorial templates refs * updates the guide_lines_tutorials.rst * delete file basic_tutorial.rst * Update doc/source/getting_started/write_doc/guide_lines_tutorials.rst * Update doc/source/getting_started/write_doc/tutorial_structure_template.rst * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * updates the links references in the rst files * updates the links references in the install.rst file * redirect to the PyAnsys guidelines for developing code and add the installation explanation before cloning * redirect to the PyAnsys guidelines for developing documentation * add new links and substitution text to the links_and_refs.rst file * update text in index.rst (write doc) * update the guide_lines_tutorials.rst * update the tutorial_structure_template.rst * add the installing dpf server explanation to the write code index.rst * add the link to the jupyter execute extension doc to the links_and_refs.rst file * rename the guidelines_tutorials.rst file * updates the guidelines_tutorials.rst name in the toctree of the write doc index.rst * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * Update doc/source/getting_started/write_doc/guidelines_tutorials.rst Co-authored-by: Paul Profizi <[email protected]> * Apply suggestions from code review Co-authored-by: Paul Profizi <[email protected]> * updates the index.rst of the write doc section * add a new link to the links_and_refs.rst file --------- Co-authored-by: Paul Profizi <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR add the tutorials section in the documentation
Preview on how it renders: