Skip to content

Commit fa74133

Browse files
feat: add other tools to project.yaml file (#857)
* feat: add other tools to toml file * feat: add other tools yaml file * Update projects.yaml Co-authored-by: Jorge Martínez <[email protected]> * feat: add general tags * feat: add pyansys-logo to pyansys tools * feat: add pyansys-logo to pyansys tools only * feat: rename pyansys light to pyansys common --------- Co-authored-by: Jorge Martínez <[email protected]>
1 parent 4d0d5c7 commit fa74133

File tree

7 files changed

+240
-115
lines changed

7 files changed

+240
-115
lines changed
35.1 KB
Loading

doc/source/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ PyAnsys packages API reference
2424
:gutter: 3 3 4 4
2525

2626
{% for project, metadata in projects['projects'].items() %}
27+
{% if 'Tools' not in metadata['family'] %}
2728
.. grid-item-card:: {{ metadata['name'] }}
2829
:img-top: {{ metadata['thumbnail'] }}
2930
:link: {{ metadata['documentation']['api'] }}
3031
:class-title: pyansys-card-title
3132

33+
{% endif %}
3234
{% endfor %}

doc/source/examples.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,11 @@ PyAnsys packages examples
1919
:gutter: 3 3 4 4
2020

2121
{% for project, metadata in projects['projects'].items() %}
22+
{% if 'Tools' not in metadata['family'] %}
2223
.. grid-item-card:: {{ metadata['name'] }}
2324
:img-top: {{ metadata['thumbnail'] }}
2425
:link: {{ metadata['documentation']['examples'] }}
2526
:class-title: pyansys-card-title
2627

28+
{% endif %}
2729
{% endfor %}

doc/source/tools/standalone/index.rst

Lines changed: 61 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -6,124 +6,94 @@ Standalone projects
66
General purpose
77
---------------
88

9-
.. grid:: 3
10-
:gutter: 3 3 4 4
9+
.. jinja:: project_context
1110

12-
.. grid-item-card:: Ansys Python Manager
13-
:img-top: ../../_static/thumbnails/ansys-python-manager.png
14-
:link: https://installer.docs.pyansys.com/version/stable
15-
:class-title: pyansys-card-title
11+
.. grid:: 3
12+
:gutter: 3 3 4 4
1613

17-
Simple cross-platform QT application to install Python and PyAnsys packages
14+
{% for project, metadata in projects['projects'].items() %}
15+
{% if 'General purpose' in metadata['tags'] %}
16+
.. grid-item-card:: {{ metadata['name'] }}
17+
:img-top: {{ metadata['thumbnail'] }}
18+
:link: {{ metadata['documentation']['base'] }}
19+
:class-title: pyansys-card-title
1820

19-
.. grid-item-card:: PyAnsys Cheat Sheets
20-
:img-top: ../../_static/thumbnails/pyansys-cheat-sheets.png
21-
:link: https://cheatsheets.docs.pyansys.com/
22-
:class-title: pyansys-card-title
23-
24-
PyAnsys cheat sheets for different libraries as quick reference guides
25-
26-
.. grid-item-card:: Ansys 5G Wizard
27-
:img-top: ../../_static/thumbnails/5gwizard.png
28-
:link: https://github.com/ansys/5G-Wizard
29-
:class-title: pyansys-card-title
30-
31-
Ansys project used to calculate Power Density or Cumulative Distribution Function
21+
{{ metadata['description'] }}
22+
{% endif %}
23+
{% endfor %}
3224

3325
Demo purposes
3426
-------------
3527

36-
.. grid:: 3
37-
:gutter: 3 3 4 4
28+
.. jinja:: project_context
29+
30+
.. grid:: 3
31+
:gutter: 3 3 4 4
3832

39-
.. grid-item-card:: API Eigen Example
40-
:img-top: ../../_static/thumbnails/intro.png
41-
:link: https://apieigen.docs.ansys.com/
42-
:class-title: pyansys-card-title
33+
{% for project, metadata in projects['projects'].items() %}
34+
{% if 'Demo' in metadata['tags'] %}
35+
.. grid-item-card:: {{ metadata['name'] }}
36+
:img-top: {{ metadata['thumbnail'] }}
37+
:link: {{ metadata['documentation']['base'] }}
38+
:class-title: pyansys-card-title
4339

44-
Demonstrating the REST and gRPC communication protocols via client-server interactions
40+
{{ metadata['description'] }}
41+
{% endif %}
42+
{% endfor %}
4543

4644
Repository management
4745
---------------------
4846

49-
.. grid:: 3
50-
:gutter: 3 3 4 4
51-
52-
.. grid-item-card:: Ansys Repository Templates
53-
:img-top: ../../_static/thumbnails/intro.png
54-
:link: https://templates.ansys.com/version/stable
55-
:class-title: pyansys-card-title
56-
57-
Ansys tool for creating new projects according to Ansys guidelines
58-
59-
.. grid-item-card:: Ansys GitHub Actions
60-
:img-top: ../../_static/thumbnails/intro.png
61-
:link: https://actions.docs.ansys.com/version/stable
62-
:class-title: pyansys-card-title
47+
.. jinja:: project_context
6348

64-
Collection of GitHub Workflows to be reused by projects in the Ansys ecosystem
49+
.. grid:: 3
50+
:gutter: 3 3 4 4
6551

66-
.. grid-item-card:: Ansys ``pre-commit`` Hooks
67-
:img-top: ../../_static/thumbnails/intro.png
68-
:link: https://pre-commit-hooks.docs.ansys.com/version/stable
69-
:class-title: pyansys-card-title
52+
{% for project, metadata in projects['projects'].items() %}
53+
{% if 'Repository management' in metadata['tags'] %}
54+
.. grid-item-card:: {{ metadata['name'] }}
55+
:img-top: {{ metadata['thumbnail'] }}
56+
:link: {{ metadata['documentation']['base'] }}
57+
:class-title: pyansys-card-title
7058

71-
Ansys repository containing customized pre-commit hooks
72-
73-
.. grid-item-card:: Ansys Tools Repository Sync
74-
:img-top: ../../_static/thumbnails/intro.png
75-
:link: https://ansys.github.io/ansys-tools-repo-sync/version/stable
76-
:class-title: pyansys-card-title
77-
78-
Ansys tool intended to synchronize the content of two different repositories
79-
80-
.. grid-item-card:: Ansys ``all-members`` team
81-
:img-top: ../../_static/thumbnails/intro.png
82-
:link: https://github.com/ansys/ansys-all-members
83-
:class-title: pyansys-card-title
84-
85-
Repository for updating an organization's ``all-members`` team automatically
59+
{{ metadata['description'] }}
60+
{% endif %}
61+
{% endfor %}
8662

8763
Artificial intelligence
8864
-----------------------
8965

90-
.. grid:: 3
91-
:gutter: 3 3 4 4
66+
.. jinja:: project_context
9267

93-
.. grid-item-card:: Reviewer Bot
94-
:img-top: ../../_static/thumbnails/intro.png
95-
:link: https://review-bot.docs.pyansys.com/version/stable
96-
:class-title: pyansys-card-title
68+
.. grid:: 3
69+
:gutter: 3 3 4 4
9770

98-
Python development tool for leveraging the power of OpenAI to automatically
99-
generate suggestions for improving GitHub pull requests
71+
{% for project, metadata in projects['projects'].items() %}
72+
{% if 'Artificial intelligence' in metadata['tags'] %}
73+
.. grid-item-card:: {{ metadata['name'] }}
74+
:img-top: {{ metadata['thumbnail'] }}
75+
:link: {{ metadata['documentation']['base'] }}
76+
:class-title: pyansys-card-title
10077

78+
{{ metadata['description'] }}
79+
{% endif %}
80+
{% endfor %}
10181

10282
Documentation
10383
-------------
10484

105-
.. grid:: 3
106-
:gutter: 3 3 4 4
107-
108-
.. grid-item-card:: Ansys Sphinx Theme
109-
:img-top: ../../_static/thumbnails/intro.png
110-
:link: https://sphinxdocs.ansys.com/version/stable
111-
:class-title: pyansys-card-title
112-
113-
Extension of the popular `PyData Sphinx Theme`_ that is used by `Numpy`_,
114-
`Pandas`_, `PyVista`_, and many more scientific Python packages
115-
116-
.. grid-item-card:: PyMeilisearch
117-
:img-top: ../../_static/thumbnails/intro.png
118-
:link: https://pymeilisearch.docs.ansys.com/version/stable
119-
:class-title: pyansys-card-title
85+
.. jinja:: project_context
12086

121-
Enhanced Python API to Meilisearch
87+
.. grid:: 3
88+
:gutter: 3 3 4 4
12289

123-
.. grid-item-card:: PyConverter-XML2Py
124-
:img-top: ../../_static/thumbnails/intro.png
125-
:link: https://review-bot.docs.pyansys.com/version/stable
126-
:class-title: pyansys-card-title
90+
{% for project, metadata in projects['projects'].items() %}
91+
{% if 'Documentation' in metadata['tags'] %}
92+
.. grid-item-card:: {{ metadata['name'] }}
93+
:img-top: {{ metadata['thumbnail'] }}
94+
:link: {{ metadata['documentation']['base'] }}
95+
:class-title: pyansys-card-title
12796

128-
Python development tool for leveraging the power of OpenAI to automatically
129-
generate suggestions for improving GitHub pull requests
97+
{{ metadata['description'] }}
98+
{% endif %}
99+
{% endfor %}

doc/source/tools/toolkits/index.rst

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,18 @@ PyAnsys toolkits
55

66
PyAEDT toolkits
77
---------------
8+
.. jinja:: project_context
89

9-
.. grid:: 3
10-
:gutter: 3 3 4 4
10+
.. grid:: 3
11+
:gutter: 3 3 4 4
1112

12-
.. grid-item-card:: PyAEDT Common Toolkit
13-
:img-top: ../../_static/thumbnails/intro.png
14-
:link: https://aedt.common.toolkit.docs.pyansys.com/version/stable
15-
:class-title: pyansys-card-title
13+
{% for project, metadata in projects['projects'].items() %}
14+
{% if 'PyAEDT toolkits' in metadata['tags'] %}
15+
.. grid-item-card:: {{ metadata['name'] }}
16+
:img-top: {{ metadata['thumbnail'] }}
17+
:link: {{ metadata['documentation']['base'] }}
18+
:class-title: pyansys-card-title
1619

17-
Shared Ansys Electronics Desktop (AEDT) toolkit components to enable package
18-
interoperability and minimize maintenance
19-
20-
.. grid-item-card:: PyAEDT Antenna Toolkit
21-
:img-top: ../../_static/thumbnails/intro.png
22-
:link: https://aedt.antenna.toolkit.docs.pyansys.com/version/stable
23-
:class-title: pyansys-card-title
24-
25-
Python wrapper for modeling antennas using Ansys Electronics Desktop (AEDT) via PyAEDT
26-
27-
.. grid-item-card:: Magnet Segmentation Toolkit
28-
:img-top: ../../_static/thumbnails/intro.png
29-
:link: https://magnet.segmentation.toolkit.docs.pyansys.com/version/stable
30-
:class-title: pyansys-card-title
31-
32-
Python wrapper for automating the segmentation and skew of interior permanent magnet (IPM)
33-
and surface permanent magnet (SPM) motors using Ansys Electronics Desktop (AEDT)
20+
{{ metadata['description'] }}
21+
{% endif %}
22+
{% endfor %}

doc/source/user_guide.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ PyAnsys packages user guides
1616
:gutter: 3 3 4 4
1717

1818
{% for project, metadata in projects['projects'].items() %}
19+
{% if 'Tools' not in metadata['family'] %}
1920
.. grid-item-card:: {{ metadata['name'] }}
2021
:img-top: {{ metadata['thumbnail'] }}
2122
:link: {{ metadata['documentation']['user_guide'] }}
2223
:class-title: pyansys-card-title
23-
24+
{% endif %}
2425
{% endfor %}

0 commit comments

Comments
 (0)