diff --git a/doc/source/_static/thumbnails/pyansys-cheat-sheets.png b/doc/source/_static/thumbnails/pyansys-cheat-sheets.png new file mode 100644 index 00000000..b44a29d9 Binary files /dev/null and b/doc/source/_static/thumbnails/pyansys-cheat-sheets.png differ diff --git a/doc/source/index.rst b/doc/source/index.rst index 5704156a..3c0a6b6a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,7 +13,7 @@ it is now a collection of many Python packages for using Ansys products through user_guide api examples - tools + tools/index .. grid:: 3 diff --git a/doc/source/tools.rst b/doc/source/tools.rst deleted file mode 100644 index e5cbca0e..00000000 --- a/doc/source/tools.rst +++ /dev/null @@ -1,80 +0,0 @@ -Other tools -=========== - -Tooling libraries delivered with the **extra** target as well as other standalone tools -that can be installed or used. - -******************* -Standalone projects -******************* - -.. grid:: 3 - - .. grid-item-card:: Ansys Python Manager - :img-top: _static/thumbnails/ansys-python-manager.png - :link: https://installer.docs.pyansys.com/version/stable - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Simple cross-platform QT application to install Python and PyAnsys packages - - .. grid-item-card:: Ansys ``pre-commit`` hooks - :img-top: _static/thumbnails/intro.png - :link: https://pre-commit-hooks.docs.ansys.com/version/stable - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Ansys repository containing customized pre-commit hooks - - .. grid-item-card:: Ansys Tools Repository Sync - :img-top: _static/thumbnails/intro.png - :link: https://ansys.github.io/ansys-tools-repo-sync/version/stable - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Ansys tool intended to synchronize the content of two different repositories - -***************** -Tooling libraries -***************** - -.. grid:: 3 - - .. grid-item-card:: Ansys Tools Path - :img-top: _static/thumbnails/intro.png - :link: https://path.tools.docs.pyansys.com/version/stable - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Library to locate Ansys products in a local machine - - .. grid-item-card:: PyAnsys Tools Report - :img-top: _static/thumbnails/intro.png - :link: https://report.tools.docs.pyansys.com/version/stable/ - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Tool for reporting your Python environment's package versions and hardware resources in a standardized way - - .. grid-item-card:: PyAnsys Tools Versioning - :img-top: _static/thumbnails/intro.png - :link: https://versioning.tools.docs.pyansys.com/version/stable/ - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Tool for backwards and forwards server support - - .. grid-item-card:: PyAnsys Units - :img-top: _static/thumbnails/intro.png - :link: https://units.docs.pyansys.com/version/stable/ - :text-align: center - :class-title: pyansys-card-title - :margin: 2 2 0 0 - - Pythonic interface for units, unit systems, and unit conversions diff --git a/doc/source/tools/index.rst b/doc/source/tools/index.rst new file mode 100644 index 00000000..55f5e167 --- /dev/null +++ b/doc/source/tools/index.rst @@ -0,0 +1,34 @@ +Other tools +=========== + +Standalone projects, tooling libraries and toolkits related to the PyAnsys ecosystem. + +.. grid:: 1 + + .. grid-item-card:: :octicon:`package` Standalone projects + :link: standalone/index + :link-type: doc + :margin: 2 2 0 0 + + Standalone projects to exploit the full potential of the PyAnsys ecosystem + + .. grid-item-card:: :octicon:`tools` Tooling libraries + :link: libraries/index + :link-type: doc + :margin: 2 2 0 0 + + Additional libraries delivered with the ``tools`` target of the PyAnsys metapackage + + .. grid-item-card:: :octicon:`gear` Toolkits + :link: toolkits/index + :link-type: doc + :margin: 2 2 0 0 + + Toolkits built on top of PyAnsys libraries for specific purposes. + +.. toctree:: + :hidden: + + standalone/index + libraries/index + toolkits/index \ No newline at end of file diff --git a/doc/source/tools/libraries/index.rst b/doc/source/tools/libraries/index.rst new file mode 100644 index 00000000..e07b5fd8 --- /dev/null +++ b/doc/source/tools/libraries/index.rst @@ -0,0 +1,40 @@ +Tooling libraries +================= + +.. grid:: 3 + + .. grid-item-card:: Ansys Tools Path + :img-top: ../../_static/thumbnails/intro.png + :link: https://path.tools.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Library to locate Ansys products in a local machine + + .. grid-item-card:: PyAnsys Tools Report + :img-top: ../../_static/thumbnails/intro.png + :link: https://report.tools.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Tool for reporting your Python environment's package versions and hardware resources in a standardized way + + .. grid-item-card:: PyAnsys Tools Versioning + :img-top: ../../_static/thumbnails/intro.png + :link: https://versioning.tools.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Tool for backwards and forwards server support + + .. grid-item-card:: PyAnsys Units + :img-top: ../../_static/thumbnails/intro.png + :link: https://units.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Pythonic interface for units, unit systems, and unit conversions \ No newline at end of file diff --git a/doc/source/tools/standalone/index.rst b/doc/source/tools/standalone/index.rst new file mode 100644 index 00000000..1fe7dd2e --- /dev/null +++ b/doc/source/tools/standalone/index.rst @@ -0,0 +1,120 @@ +Standalone projects +=================== + +.. contents:: + +General purpose +--------------- + +.. grid:: 3 + + .. grid-item-card:: Ansys Python Manager + :img-top: ../../_static/thumbnails/ansys-python-manager.png + :link: https://installer.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Simple cross-platform QT application to install Python and PyAnsys packages + + .. grid-item-card:: PyAnsys Cheat Sheets + :img-top: ../../_static/thumbnails/pyansys-cheat-sheets.png + :link: https://cheatsheets.docs.pyansys.com/ + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + PyAnsys cheat sheets for different libraries as quick reference guides + +Repository management +--------------------- + +.. grid:: 3 + + .. grid-item-card:: Ansys Repository Templates + :img-top: ../../_static/thumbnails/intro.png + :link: https://templates.ansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Ansys tool for creating new projects according to Ansys guidelines + + .. grid-item-card:: Ansys GitHub Actions + :img-top: ../../_static/thumbnails/intro.png + :link: https://actions.docs.ansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Collection of GitHub Workflows to be reused by projects in the Ansys ecosystem + + .. grid-item-card:: Ansys ``pre-commit`` Hooks + :img-top: ../../_static/thumbnails/intro.png + :link: https://pre-commit-hooks.docs.ansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Ansys repository containing customized pre-commit hooks + + .. grid-item-card:: Ansys Tools Repository Sync + :img-top: ../../_static/thumbnails/intro.png + :link: https://ansys.github.io/ansys-tools-repo-sync/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Ansys tool intended to synchronize the content of two different repositories + + +Artificial intelligence +----------------------- + +.. grid:: 3 + + .. grid-item-card:: Reviewer Bot + :img-top: ../../_static/thumbnails/intro.png + :link: https://review-bot.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Python development tool for leveraging the power of OpenAI to automatically + generate suggestions for improving GitHub pull requests + + +Documentation +------------- + +.. grid:: 3 + + .. grid-item-card:: Ansys Sphinx Theme + :img-top: ../../_static/thumbnails/intro.png + :link: https://sphinxdocs.ansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Extension of the popular `PyData Sphinx theme `_ + that is used by `numpy `_, `pandas `_, + `pyvista `_, and many more scientific Python packages + + .. grid-item-card:: PyMeilisearch + :img-top: ../../_static/thumbnails/intro.png + :link: https://pymeilisearch.docs.ansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Enhanced Python API to Meilisearch + + .. grid-item-card:: PyConverter-XML2Py + :img-top: ../../_static/thumbnails/intro.png + :link: https://review-bot.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Python development tool for leveraging the power of OpenAI to automatically + generate suggestions for improving GitHub pull requests diff --git a/doc/source/tools/toolkits/index.rst b/doc/source/tools/toolkits/index.rst new file mode 100644 index 00000000..eead5dd4 --- /dev/null +++ b/doc/source/tools/toolkits/index.rst @@ -0,0 +1,18 @@ +PyAnsys toolkits +================ + +.. contents:: + +PyAEDT toolkits +--------------- + +.. grid:: 3 + + .. grid-item-card:: PyAEDT Antenna Toolkit + :img-top: ../../_static/thumbnails/intro.png + :link: https://aedt.antenna.toolkit.docs.pyansys.com/version/stable + :text-align: center + :class-title: pyansys-card-title + :margin: 2 2 0 0 + + Python wrapper for modeling antennas using Ansys Electronics Desktop (AEDT) via PyAEDT \ No newline at end of file diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt index 83a4635c..0e7a9c24 100644 --- a/doc/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -17,3 +17,4 @@ PyPIM Granta MI BoM Analytics metapackage PyTwin +toolkits \ No newline at end of file