Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Devin <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
  • Loading branch information
3 people authored Jun 27, 2024
1 parent 2e2a3b7 commit 9731687
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
3 changes: 2 additions & 1 deletion doc/source/Getting_started/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ The user can select the AEDT application to install the specific workflow.
:width: 400
:alt: PyAEDT toolkit manager 2

For more extension information, see `Extensions <https://aedt.docs.pyansys.com/version/stable/User_guide/extensions.html>`_.
For additional information about AEDT extensions,
see `Extensions <https://aedt.docs.pyansys.com/version/stable/User_guide/extensions.html>`_.


Install on CPython from PyPI
Expand Down
8 changes: 4 additions & 4 deletions doc/source/User_guide/extensions.rst
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
Extensions
==========

PyAEDT extensions provide a simplified interface to perform automated workflows.
Extensions provide a simplified interface to perform automated workflows in AEDT.
The user can install or uninstall these extensions using the extension manager.
For more information, see `Extension Manager <https://aedt.docs.pyansys.com/version/stable/Getting_started/Installation.html#extension-manager>`_.

Depending on the application, the user can find different extensions, the following sections describe each of them.
Extensions are generally tool-specific and are therefore only accessible given the appropriate context. The following sections provide further clarification.

Extensions can be launched in standalone mode from the console or from a python script. This is described on each extension section.

Project extensions
==================

Project extension apply to all extensions that are visible to all kind of AEDT applications.
Project extension apply to all extensions that are applicable for all AEDT applications.

.. grid:: 2

.. grid-item-card:: Import Nastran
:link: pyaedt_extensions_doc/project
:link-type: doc

Import Nastran or STL file in any 3D modeler application.
Import a Nastran or STL file in any 3D modeler application.

.. toctree::
:hidden:
Expand Down
4 changes: 2 additions & 2 deletions doc/source/User_guide/pyaedt_extensions_doc/project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Import Nastran
Import Nastran or STL file in any 3D modeler application. The user can also preview the imported file and decimate it before import it.

Check failure on line 4 in doc/source/User_guide/pyaedt_extensions_doc/project.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/User_guide/pyaedt_extensions_doc/project.rst#L4

[Vale.Spelling] Did you really mean 'Nastran'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Nastran'?", "location": {"path": "doc/source/User_guide/pyaedt_extensions_doc/project.rst", "range": {"start": {"line": 4, "column": 8}}}, "severity": "ERROR"}

User can access the extension from the icon created in the Automation tab through the extension manager.
The following image is the extension user interface:
The following image shows the extension user interface:

.. image:: import_nastran_ui.png
:width: 800
Expand All @@ -24,7 +24,7 @@ The available arguments are: file_path, planar, lightweight, and decimate. These
python.exe path/to/pyaedt/workflows/project/import_nastran.py --help
For example, you can pass the input file as an argument, and in this case the user interface is not launched:
This code shows how to pass the input file as an argument, which doesn't launch the user interface:

.. code::
Expand Down

0 comments on commit 9731687

Please sign in to comment.