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.

Sign up for GitHub

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
Merged

Add badges for supported solvers #1925

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d134899
Add custom badges for supported solvers
PProfizi Nov 25, 2024
1536a7e
Test custom badges
PProfizi Nov 25, 2024
2e54316
Merge branch 'doc/new-tutorials-section' into doc/add_solver_badges
PProfizi Nov 25, 2024
1bb0070
Update conf.py
PProfizi Nov 25, 2024
443e415
Update doc/source/conf.py
PProfizi Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions doc/source/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,15 @@
.wy-table-responsive table td, .wy-table-responsive table th {
white-space: normal;
}
/* Check https://www.w3schools.com/cssref/css_colors.php for colors */
/* Ansys gold for MAPDL with black text*/
.sd-bg-mapdl{background-color: #FFB71B}
.sd-bg-text-mapdl{color: Black}
/* Ansys orange accent color for Fluent with black text*/
.sd-bg-lsdyna{background-color: #FB471F}
.sd-bg-text-lsdyna{color: Black}
/* Ansys blue accent color #00629F for Fluent with black text*/
.sd-bg-fluent{background-color: #0081D0}
.sd-bg-text-fluent{color: Black}
.sd-bg-cfx{background-color: LightSeaGreen}
.sd-bg-text-cfx{color: Black}
9 changes: 9 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,3 +324,12 @@ def reset_servers(gallery_conf, fname, when):

# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]

# Define custom docutils roles for solver badges
from sphinx_design.badges_buttons import BadgeRole

def setup(app):
app.add_role(name="bdg-mapdl", role=BadgeRole(color="mapdl"))
app.add_role(name="bdg-cfx", role=BadgeRole(color="cfx"))
app.add_role(name="bdg-fluent", role=BadgeRole(color="fluent"))
app.add_role(name="bdg-lsdyna", role=BadgeRole(color="lsdyna"))
PProfizi marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions doc/source/user_guide/tutorials/animate/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ These tutorials demonstrate how to visualise the data in an animation.
:text-align: center

This tutorial
+++
:bdg-mapdl:`MAPDL` :bdg-lsdyna:`LS-DYNA` :bdg-fluent:`FLUENT` :bdg-cfx:`CFX`

.. toctree::
:maxdepth: 2
Expand Down
Loading