Add tutorials and update User Guide layout #1749
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,8 +3,10 @@ | |
| ============= | ||
| API reference | ||
| ============= | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: API reference | ||
|
|
||
| ansys.dpf.core | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -193,5 +193,5 @@ To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@a | |
| examples/index | ||
| api/index | ||
| operator_reference | ||
| contributing | ||
|
|
||
File renamed without changes.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,17 +3,6 @@ | |
| How-tos | ||
| ~~~~~~~ | ||
|
|
||
| .. card-carousel:: 2 | ||
|
|
||
| .. card:: Plot | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,35 @@ The goals of this section are to: | |
| - Describe the most-used DPF entities and how they can help you to access and modify solver data. | ||
| - Provide simple how-tos for tackling the most common use cases. | ||
|
|
||
| Concepts | ||
| -------- | ||
|
|
||
| .. card-carousel:: 2 | ||
|
|
||
| .. card:: Concepts and terminology | ||
| :link: user_guide_concepts | ||
| :link-type: ref | ||
| :width: 25% | ||
| :text-align: center | ||
|
|
||
| .. image:: ../images/drawings/book-logo.png | ||
|
|
||
| .. card:: Ways of using DPF | ||
| :link: user_guide_waysofusing | ||
| :link-type: ref | ||
| :width: 25% | ||
| :text-align: center | ||
|
|
||
| .. image:: ../images/drawings/using-dpf.png | ||
|
|
||
| .. card:: Using DPF: Step by step | ||
| :link: user_guide_stepbystep | ||
| :link-type: ref | ||
| :width: 25% | ||
| :text-align: center | ||
|
|
||
| .. image:: ../images/drawings/checklist.png | ||
|
|
||
|
|
||
| .. include:: | ||
| main_entities.rst | ||
|
|
@@ -22,7 +51,34 @@ The goals of this section are to: | |
|
|
||
|
|
||
| Troubleshooting | ||
| --------------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :hidden: | ||
| :caption: Concepts | ||
|
|
||
| concepts.rst | ||
| waysofusing.rst | ||
| stepbystep.rst | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :hidden: | ||
| :caption: Tutorials | ||
|
|
||
| model | ||
| operators | ||
| fields_container | ||
| plotting | ||
| custom_operators | ||
| server_context | ||
| server_types | ||
| xmlfiles | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :hidden: | ||
| :caption: Troubleshooting | ||
|
|
||
| troubleshooting | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,13 @@ | ||
| .. _ref_main_entities: | ||
|
|
||
| Tutorials | ||
| --------- | ||
|
|
||
| The following tutorials shows in details how to use basic features of PyDPF-Core | ||
| for each usage main step. | ||
luisaFelixSalles marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Define simulation data | ||
luisaFelixSalles marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| .. card-carousel:: 2 | ||
|
|
||
|
|
@@ -18,24 +17,24 @@ DPF most-used entities | |
| :width: 25% | ||
| :text-align: center | ||
|
|
||
| .. card:: DPF model | ||
| :link: user_guide_model | ||
| :link-type: ref | ||
| :width: 25% | ||
| :text-align: center | ||
|
|
||
| .. card:: Fields container and fields | ||
| :link: ref_user_guide_fields_container | ||
| :link-type: ref | ||
| :width: 25% | ||
| :text-align: center | ||
|
|
||
| .. card:: Operators | ||
| :link: ref_user_guide_operators | ||
| :link-type: ref | ||
| :width: 25% | ||
| :text-align: center | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
File renamed without changes.
File renamed without changes.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,5 @@ | |
| Examples | ||
| ======== | ||
| These examples demonstrate the behavior and usage of DPF-Core. | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| enum-tools[sphinx]==0.12.0 | ||
| graphviz==0.20.1 | ||
| imageio==2.34.1 | ||
|
|
@@ -10,8 +9,10 @@ pyvista==0.44.1 | |
| sphinx==7.1.0 | ||
| sphinx-autobuild==2024.2.4 | ||
| sphinx-copybutton==0.5.2 | ||
| sphinx-gallery==0.17.1 | ||
| sphinx-notfound-page==1.0.0 | ||
| sphinx-reredirects==0.1.3 | ||
| sphinx_design==0.6.1 | ||
| sphinxcontrib-napoleon==0.7 | ||
| ansys-sphinx-theme[autoapi]==1.0.8 | ||
| numpydoc==1.8.0 | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@luisaFelixSalles why do we need this change? Is it going to work in dark mode?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current nav bar looks like this:
The logo has a black square background, but we dont see it because the navigation bar also has a black background.:
So, I changed the logo for the one with a light back ground, to match the new navigation bar color. It actually doesn't look good in dark mode, I'll look into other projects to see how they do it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Revathyvenugopal162 I would like to ask for your help also in this case:
I tried passing the logo as an html configuration option with:
But I get the following error when building the documentation:
Do you know if I'm missing other configuration changes in other to solve this problem?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This wont work with out new theme. Please add this "logo": "pyansys" in theme options. example PR , ansys/pyansys-geometry@40366c1#diff-d8d3ed25802824d15bf411f8e97416d8fc6f9247e821b0617f2b869dc584b99c
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried this but it gives me the same error.
Is there a way to implement the logo (that respects the light and dark modes) with the new theme?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@luisaFelixSalles @PProfizi The logo issue was fixed in 33fade6 and this is the first time we are getting this issue. i will keep track on this and try to fix it in ansys sphinx theme if required. The recommended way is using "logo":"pyansys" in theme options.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your help ! 🙂