Skip to content

Feat: Add option for generating docs without examples#830

Merged
dipinknair merged 9 commits intomainfrom
feat/html-no-plot
Jul 26, 2024
Merged

Feat: Add option for generating docs without examples#830
dipinknair merged 9 commits intomainfrom
feat/html-no-plot

Conversation

@dipinknair
Copy link
Collaborator

@dipinknair dipinknair commented Jul 23, 2024

usage: .\doc\make.bat html-noplot

This is helpful if you want to generate docs without having to run Mechanical for examples @ansys/pyansys-core

@dipinknair dipinknair requested a review from a team as a code owner July 23, 2024 01:51
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels Jul 23, 2024
@github-actions github-actions bot added maintenance Package and maintenance related CI/CD labels Jul 23, 2024
@codecov
Copy link

codecov bot commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.80%. Comparing base (6ce7156) to head (3a758ea).

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     

@dipinknair dipinknair marked this pull request as draft July 23, 2024 12:32
@dipinknair dipinknair marked this pull request as ready for review July 24, 2024 21:42
@dipinknair dipinknair requested a review from a team July 25, 2024 14:55
@Revathyvenugopal162
Copy link
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.

@dipinknair dipinknair merged commit 1e45c45 into main Jul 26, 2024
@dipinknair dipinknair deleted the feat/html-no-plot branch July 26, 2024 14:03
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 enhancement New features or code improvements maintenance Package and maintenance related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants