Skip to content
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

Add badges for supported solvers #1925

Merged
merged 5 commits into from
Nov 26, 2024

Conversation

PProfizi
Copy link
Contributor

@PProfizi PProfizi commented Nov 25, 2024

This PR adds custom badges to mark things in the doc as specific to certain solvers.

@PProfizi PProfizi added the documentation Improvements or additions to documentation label Nov 25, 2024
@PProfizi
Copy link
Contributor Author

PProfizi commented Nov 25, 2024

Hey @Revathyvenugopal162, I think this I managed to do something that works and is specific to PyDPF-Core (since the need is specific to our doc) and does not clash with the ansys-sphinx-theme.
You mentioned a validation step for the colors?

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.03%. Comparing base (1dd2cdb) to head (443e415).
Report is 1 commits behind head on doc/new-tutorials-section.

Additional details and impacted files
@@                      Coverage Diff                      @@
##           doc/new-tutorials-section    #1925      +/-   ##
=============================================================
- Coverage                      88.15%   88.03%   -0.13%     
=============================================================
  Files                             83       83              
  Lines                           9973     9973              
=============================================================
- Hits                            8792     8780      -12     
- Misses                          1181     1193      +12     

@Revathyvenugopal162
Copy link
Contributor

Hey @Revathyvenugopal162, I think this I managed to do something that works and is specific to PyDPF-Core (since the need is specific to our doc) and does not clash with the ansys-sphinx-theme. You mentioned a validation step for the colors?

yes, If you took the standard ansys colors (may be from theme or from any other sources), you should be good to go, anyway i will double check with ui/ux after we merge this.

Co-authored-by: Revathy Venugopal <[email protected]>
@PProfizi PProfizi merged commit d5ad6a1 into doc/new-tutorials-section Nov 26, 2024
46 checks passed
@PProfizi PProfizi deleted the doc/add_solver_badges branch November 26, 2024 10:52
luisaFelixSalles pushed a commit that referenced this pull request Dec 19, 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]>
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants