Skip to content

Commit

Permalink
docs: adapt static images to dark/light themes (#3249)
Browse files Browse the repository at this point in the history 
* fix: italics

* docs: adapting tables

* docs: adapting cicd image

* docs: changing rst structure image. compatible both themes.

* docs: change dcb_test image

* docs: changing architecture diagram

* chore: adding changelog file 3249.miscellaneous.md

* chore: adding changelog file 3249.miscellaneous.md

* fix: wrong extension and table alignments

* fix: malformed table

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Camille <[email protected]>
  • Loading branch information
@germa89 @pyansys-ci-bot @clatapie
3 people authored Jul 9, 2024
1 parent ca0b43a commit 3bc6c7d
Show file tree
Hide file tree
Showing 16 changed files with 83 additions and 55 deletions.
1 change: 1 addition & 0 deletions doc/changelog.d/3249.miscellaneous.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs: adapt static images to dark/light themes
8 changes: 7 additions & 1 deletion doc/source/getting_started/develop_pymapdl.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,9 +275,15 @@ The automation of testing, monitoring, and deployment of newly added
code allows continuous deployment (CD) throughout the app lifecycle,
providing a comprehensive CI/CD approach.

.. figure:: ../images/cicd.jpg
.. image:: ../images/cicd_dark_theme.png
:class: only-dark
:width: 300pt

.. image:: ../images/cicd_light_theme.png
:class: only-light
:width: 300pt


Example
--------

Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/learning.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Learning PyMAPDL
Introduction
============

.. centered:: _PyMAPDL provides Pythonic access to MAPDL, an Ansys finite element solver._
.. centered:: *PyMAPDL provides Pythonic access to MAPDL, an Ansys finite element solver.*

PyMAPDL touches on different technologies such as Python and finite elements, to bring them together
and offer you a better user experience by seamlessly connecting this Ansys solver and the Python ecosystem.
Expand Down
13 changes: 12 additions & 1 deletion doc/source/getting_started/project.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,22 @@ while producing network footprints that are compact and efficient.

The following diagram presents a simplified architecture of PyMAPDL.

.. figure:: ../images/architecture_diagram.png
.. figure:: ../images/architecture_diagram_dark_theme.png
:figclass: only-dark
:width: 400pt
:alt: PyMAPDL architecture diagram

PyMAPDL architecture diagram


.. figure:: ../images/architecture_diagram_light_theme.png
:figclass: only-light
:width: 400pt
:alt: PyMAPDL architecture diagram

PyMAPDL architecture diagram


Quick code
----------
Here's a brief example of how PyMAPDL works:
Expand Down
46 changes: 23 additions & 23 deletions doc/source/getting_started/versioning.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,53 +120,53 @@ The following table shows the supported versions of Ansys and the recommended in
| | +-----------------------+-----------------------+-----------------------+
| | | gRPC | CORBA | Console (Only Linux) |
+===========================+========================+=======================+=======================+=======================+
| Ansys 2023 R1 | gRPC | |:heavy_check_mark:| | |:heavy_minus_sign:| | |:heavy_minus_sign:| |
| Ansys 2023 R1 | gRPC | |:white_check_mark:| | |:exclamation:| | |:exclamation:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2022 R2 | gRPC | |:heavy_check_mark:| | |:heavy_minus_sign:| | |:heavy_minus_sign:| |
| Ansys 2022 R2 | gRPC | |:white_check_mark:| | |:exclamation:| | |:exclamation:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2022 R1 | gRPC | |:heavy_check_mark:| | |:heavy_minus_sign:| | |:heavy_minus_sign:| |
| Ansys 2022 R1 | gRPC | |:white_check_mark:| | |:exclamation:| | |:exclamation:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2021 R2 | gRPC | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_minus_sign:| |
| Ansys 2021 R2 | gRPC | |:white_check_mark:| | |:white_check_mark:| | |:exclamation:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2021 R1 | gRPC | |:heavy_check_mark:| | |:heavy_check_mark:| | |:heavy_minus_sign:| |
| Ansys 2021 R1 | gRPC | |:white_check_mark:| | |:white_check_mark:| | |:exclamation:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2020 R2 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 2020 R2 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2020 R1 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 2020 R1 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2019 R3 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 2019 R3 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2019 R2 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 2019 R2 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 2019 R1 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 2019 R1 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 19.2 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 19.2 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 19.1 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 19.1 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 19.0 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 19.0 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 18.2 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 18.2 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 18.1 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 18.1 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 18.0 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 18.0 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 17.2 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 17.2 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 17.1 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 17.1 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 17.0 | CORBA | |:x:| | |:heavy_check_mark:| | |:heavy_check_mark:| |
| Ansys 17.0 | CORBA | |:x:| | |:white_check_mark:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Ansys 16.2 | Console | |:x:| | |:x:| | |:heavy_check_mark:| |
| Ansys 16.2 | Console | |:x:| | |:x:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+
| Older up to Ansys 13.0 | Console | |:x:| | |:x:| | |:heavy_check_mark:| |
| Older up to Ansys 13.0 | Console | |:x:| | |:x:| | |:white_check_mark:| |
+---------------------------+------------------------+-----------------------+-----------------------+-----------------------+

Where:

* |:heavy_check_mark:| means that the interface is supported and recommended.
* |:heavy_minus_sign:| means that the interface is supported, but not recommended. Their support might be dropped in the future.
* |:white_check_mark:| means that the interface is supported and recommended.
* |:exclamation:| means that the interface is supported, but not recommended. Their support might be dropped in the future.
* |:x:| means that the interface is not supported.


Expand Down
Binary file removed doc/source/images/architecture_diagram.png
View file
Binary file not shown.
Binary file added doc/source/images/architecture_diagram_dark_theme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/architecture_diagram_light_theme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/source/images/cicd.jpg
View file
Binary file not shown.
Binary file added doc/source/images/cicd_dark_theme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/cicd_light_theme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/dcb_test_dark_theme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/source/images/dcb_test_light_theme.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/source/images/rst_structure.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3bc6c7d

Please sign in to comment.