-
Notifications
You must be signed in to change notification settings - Fork 139
Extended examples as a section of examples #1029
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
Extended examples as a section of examples #1029
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1029 +/- ##
==========================================
- Coverage 71.33% 71.32% -0.02%
==========================================
Files 43 43
Lines 6085 6086 +1
==========================================
Hits 4341 4341
- Misses 1744 1745 +1 |
Fully agree with this approach. |
Just two small suggestions that can be ignored if too much trouble:
|
This was a complicated one. The issue is that sphinx is reporting duplicated labels because it reads through every file matching Normally, we could just rename it to |
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.
Finally!
Because we made major changes, our doc cache needed to be cleared. I did this by bumping:
https://github.com/pyansys/pymapdl/blob/312ebb0ec1d8d55bef864584ee925e26e6593fb8/pyproject.toml#L8
As requested in #1019 I have decided to move that section to the Example section.
Results
Things to notice
Now, in the directory
/doc/source/examples/
there is two folders:examples
where all the dynamic examples are located during the building process, andextended_examples
where the static extended examples are located. I have modified theMakeFile
to just delete/doc/source/examples/examples/
. But it is good to notice.I also renamed some example sections (titles)
I personally believe we should make all the TechDemos statics. DONE.
== Edit ==
This PR closes #1019.