From 0b9d895ba514c9809adc91cc0cba0d96463c35e3 Mon Sep 17 00:00:00 2001 From: DulceRiosK Date: Mon, 23 Sep 2024 07:09:40 -0700 Subject: [PATCH] DOCS: added FIlterSolutions to toc tree autosummary and index file. (#5172) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com> Co-authored-by: Sebastien Morais --- doc/source/API/Application.rst | 1 + doc/source/API/index.rst | 2 ++ src/ansys/aedt/core/filtersolutions.py | 5 ++--- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/source/API/Application.rst b/doc/source/API/Application.rst index 74951455342..d7ad0ed6724 100644 --- a/doc/source/API/Application.rst +++ b/doc/source/API/Application.rst @@ -27,6 +27,7 @@ Available PyAEDT apps are: ansys.aedt.core.maxwellcircuit.MaxwellCircuit ansys.aedt.core.emit.Emit ansys.aedt.core.twinbuilder.TwinBuilder + ansys.aedt.core.filtersolutions.FilterSolutions All other classes and methods are inherited into the app class. diff --git a/doc/source/API/index.rst b/doc/source/API/index.rst index 519b0c88a30..744f88bc650 100644 --- a/doc/source/API/index.rst +++ b/doc/source/API/index.rst @@ -36,6 +36,8 @@ PyAEDT app to get access to all modules and methods. Available apps are: - EMIT - Circuit - `TwinBuilder `_ +- `FilterSolutions `_ + All other classes and methods are inherited into the app class. The desktop app is implicitly launched in any of the other applications. diff --git a/src/ansys/aedt/core/filtersolutions.py b/src/ansys/aedt/core/filtersolutions.py index 0c6e6132aaa..4b65297c319 100644 --- a/src/ansys/aedt/core/filtersolutions.py +++ b/src/ansys/aedt/core/filtersolutions.py @@ -46,13 +46,12 @@ class FilterSolutions: Parameters ---------- - version: str, optional + version : str, optional Version of AEDT in ``xxxx.x`` format. The default is ``None``. - implementation_type: FilterImplementation, optional + implementation_type : FilterImplementation, optional Technology used to implement the filter. The default is ``LUMPED``. The ``FilterImplementation`` enum provides the list of implementations. - Examples -------- Create a ``FilterSolutions`` instance with a band-pass elliptic ideal filter.