Feat: Add option for generating docs without examples#830
Merged
dipinknair merged 9 commits intomainfrom Jul 26, 2024
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #830 +/- ##
==========================================
- Coverage 81.90% 81.80% -0.10%
==========================================
Files 32 32
Lines 2100 2100
==========================================
- Hits 1720 1718 -2
- Misses 380 382 +2 |
Contributor
|
I think It would be helpful to document this in either the contributing guide or the development mode installation section as a note for anyone looking to contribute without building examples locally. Additionally, adding this information to our dev docs, including a link to the Sphinx Gallery configuration and a note about the plot gallery option, would be beneficial. |
Revathyvenugopal162
approved these changes
Jul 26, 2024
This file contains hidden or 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
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.
usage:
.\doc\make.bat html-noplotThis is helpful if you want to generate docs without having to run Mechanical for examples @ansys/pyansys-core