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

Adding PyMAPDL logo #2647

Merged
merged 5 commits into from
Jan 11, 2024
Merged

Adding PyMAPDL logo #2647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
613815b
Adding logos.
germa89 Jan 11, 2024
9b9251b
Using logo in main pages (theme aware)
germa89 Jan 11, 2024
f1d3ca6
Using logos
germa89 Jan 11, 2024
e5e0435
fixing badges
germa89 Jan 11, 2024
8ec5a69
doc: applying @Revathyvenugopal162 's suggestions
clatapie Jan 11, 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
8 changes: 5 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
PyMAPDL
========

.. image:: https://github.com/ansys/pymapdl/raw/main/doc/source/_static/logo_light.png
:alt: PyMAPDL

|pyansys| |pypi| |PyPIact| |GH-CI| |codecov| |zenodo| |MIT| |black| |pre-commit|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
Expand Down Expand Up @@ -50,7 +52,7 @@ MAPDL and supports:

Here's a quick demo of PyMAPDL within Visual Studio Code:

.. image:: https://github.com/ansys/pymapdl/raw/main/doc/landing_page_demo.gif
.. image:: https://github.com/ansys/pymapdl/raw/main/doc/source/_static/landing_page_demo.gif

PyMAPDL works within Jupyter Notebooks, the standard Python console,
or in batch mode on Windows, Linux, and even Mac OS.
Expand Down
0 doc/landing_page_demo.gif → doc/source/_static/landing_page_demo.gif
View file
Open in desktop
File renamed without changes
Binary file added doc/source/_static/logo_dark.png
View file
Open in desktop
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/_static/logo_light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 19 additions & 5 deletions doc/source/getting_started/codespaces.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,18 @@ Currently, there are three main configurations:
to develop and test PyMAPDL. For instance, it has ``xvfb``
and ``pytest`` packages installed for testing.

|Open a GitHub Codespaces for developers|
|Open a GitHub Codespaces for developers-light|
|Open a GitHub Codespaces for developers-dark|


* :ref:`PyMAPDL-Codespaces-Documentation <ref_codespaces_docs_welcome>`.
This configuration is specially set for people working with the documentation or examples. Thus,
it includes the appropriate OS and Python dependencies.
For instance, it includes ``sphinx`` and ``latex`` packages for building the documentation
as HTML and PDF outputs.

|Open a GitHub Codespaces for documentation|
|Open a GitHub Codespaces for documentation-light|
|Open a GitHub Codespaces for documentation-dark|

* `PyMAPDL-DevContainer (Local) <pymapdl_codespaces_welcome_local_>`_ **[NOT RECOMMENDED]**. This is the
configuration for launching a development container locally.
Expand Down Expand Up @@ -140,9 +143,20 @@ Limitations



.. |Open a GitHub Codespaces for developers| image:: https://github.com/codespaces/badge.svg
.. Images

.. |Open a GitHub Codespaces for developers-light| image:: https://img.shields.io/badge/-Open%20GitHub%20Codespace-333?style=flat-square&logo=github
:target: https://codespaces.new/ansys/pymapdl?quickstart=1&devcontainer_path=.devcontainer%2Fdevcontainer.json
:class: only-light

.. |Open a GitHub Codespaces for developers-dark| image:: https://img.shields.io/badge/-Open%20GitHub%20Codespace-ffffff?style=flat-square&logo=github&logoColor=000000
:target: https://codespaces.new/ansys/pymapdl?quickstart=1&devcontainer_path=.devcontainer%2Fdevcontainer.json
:class: only-dark

.. |Open a GitHub Codespaces for documentation-light| image:: https://img.shields.io/badge/-Open%20GitHub%20Codespace-333?style=flat-square&logo=github
:target: https://codespaces.new/ansys/pymapdl?quickstart=1&devcontainer_path=.devcontainer%2Fcodespaces-docs%2Fdevcontainer.json
:class: only-light

.. |Open a GitHub Codespaces for documentation| image:: https://github.com/codespaces/badge.svg
:target: https://codespaces.new/ansys/pymapdl?quickstart=1&devcontainer_path=.devcontainer%2Fcodespaces-docs%2Fdevcontainer.json
.. |Open a GitHub Codespaces for documentation-dark| image:: https://img.shields.io/badge/-Open%20GitHub%20Codespace-ffffff?style=flat-square&logo=github&logoColor=000000
:target: https://codespaces.new/ansys/pymapdl?quickstart=1&devcontainer_path=.devcontainer%2Fcodespaces-docs%2Fdevcontainer.json
:class: only-dark
9 changes: 7 additions & 2 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
.. image:: ../source/_static/logo_dark.png
:class: only-dark

.. image:: ../source/_static/logo_light.png
:class: only-light


PyMAPDL documentation |version|
===============================

Expand All @@ -11,8 +18,6 @@ PyMAPDL documentation |version|
api/index
examples/index



Introduction and purpose
------------------------
PyMAPDL is part of the larger `PyAnsys <pyansys_>`_
Expand Down
Loading