Skip to content

Commit f19b5d1

Browse files
ldupsDupontjorgepilotoduposyl
authored
fix: remove duplicated interfaces causing issues in doc build (#467)
Co-authored-by: Dupont <[email protected]> Co-authored-by: Jorge Martinez <[email protected]> Co-authored-by: Sylvain <[email protected]>
1 parent 647012f commit f19b5d1

19 files changed

+93
-768
lines changed

doc/source/api/ansys/stk/core/stkdesktop/STKDesktopApplication.rst

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ Overview
2424
:header-rows: 0
2525
:widths: auto
2626

27-
* - :py:attr:`~ansys.stk.core.stkdesktop.STKDesktopApplication.root`
28-
- Get the object model root associated with this instance of STK Desktop application.
2927
* - :py:attr:`~ansys.stk.core.stkdesktop.STKDesktopApplication.new_object_model_context`
3028
- Create a new object model context for the STK Desktop application.
3129
* - :py:attr:`~ansys.stk.core.stkdesktop.STKDesktopApplication.SetGrpcOptions`
@@ -47,6 +45,17 @@ Overview
4745
* - :py:attr:`~ansys.stk.core.stkdesktop.STKDesktopApplication.shutdown`
4846
- Close this STK Desktop instance (or detach if the instance was obtained through STKDesktop.AttachToApplication()).
4947

48+
.. tab-set::
49+
50+
.. tab-item:: Properties
51+
52+
.. list-table::
53+
:header-rows: 0
54+
:widths: auto
55+
56+
* - :py:attr:`~ansys.stk.core.stkdesktop.STKDesktopApplication.root`
57+
- Get the object model root associated with this instance of STK Desktop application.
58+
5059
Import detail
5160
-------------
5261

@@ -55,17 +64,18 @@ Import detail
5564
from ansys.stk.core.stkdesktop import STKDesktopApplication
5665
5766
58-
Method detail
59-
-------------
67+
Property detail
68+
---------------
6069

61-
.. py:method:: root(self) -> StkObjectRoot
70+
.. py:property:: root
6271
:canonical: ansys.stk.core.stkdesktop.STKDesktopApplication.root
72+
:type: StkObjectRoot
6373

6474
Get the object model root associated with this instance of STK Desktop application.
6575

66-
:Returns:
6776

68-
:obj:`~StkObjectRoot`
77+
Method detail
78+
-------------
6979

7080
.. py:method:: new_object_model_context(self) -> StkObjectModelContext
7181
:canonical: ansys.stk.core.stkdesktop.STKDesktopApplication.new_object_model_context

doc/source/api/ansys/stk/core/stkobjects/DataProviderResultDataSetCollection.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,6 @@ Overview
3131
* - :py:attr:`~ansys.stk.core.stkobjects.DataProviderResultDataSetCollection.to_pandas_dataframe`
3232
- Return a row formatted dataset collection as a pandas DataFrame. This function requires ``pandas``.
3333

34-
This function optionally maps data provider element types to pandas DataFrame column dtypes and optionally sets the column to be used as the DataFrame index.
35-
36-
Args:
37-
-----
38-
indexElementName: Valid data provider element name as the column to be set as the DataFrame index.
39-
dataProviderElements: Data provider elements for the corresponding AgDrDataSetCollection to be used to automatically map data provider element types to DataFrame column dtypes.
40-
4134
.. tab-item:: Properties
4235

4336
.. list-table::

doc/source/api/ansys/stk/core/stkobjects/StkObjectRoot.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ Property detail
173173
Method detail
174174
-------------
175175

176-
.. py:method:: execute_command(self, connectCommand: str) -> IExecCmdResult
176+
.. py:method:: execute_command(self, connectCommand: str) -> ExecCmdResult
177177
:canonical: ansys.stk.core.stkobjects.StkObjectRoot.execute_command
178178

179179
Execute a custom CONNECT action. The method throws an exception if the command has failed.
@@ -184,7 +184,7 @@ Method detail
184184

185185
:Returns:
186186

187-
:obj:`~IExecCmdResult`
187+
:obj:`~ExecCmdResult`
188188

189189
.. py:method:: load_scenario(self, path: str) -> None
190190
:canonical: ansys.stk.core.stkobjects.StkObjectRoot.load_scenario
@@ -298,7 +298,7 @@ Method detail
298298

299299
:obj:`~None`
300300

301-
.. py:method:: execute_multiple_commands(self, connectCommands: list, action: EXEC_MULTI_CMD_RESULT_ACTION) -> IExecMultiCmdResult
301+
.. py:method:: execute_multiple_commands(self, connectCommands: list, action: EXEC_MULTI_CMD_RESULT_ACTION) -> ExecMultiCmdResult
302302
:canonical: ansys.stk.core.stkobjects.StkObjectRoot.execute_multiple_commands
303303

304304
Execute multiple CONNECT actions. The behavior of the method when encountering an exception varies depending on the setting of the Action parameter. See the help for AgEExecMultiCmdResultAction.
@@ -310,7 +310,7 @@ Method detail
310310

311311
:Returns:
312312

313-
:obj:`~IExecMultiCmdResult`
313+
:obj:`~ExecMultiCmdResult`
314314

315315
.. py:method:: isolate(self) -> None
316316
:canonical: ansys.stk.core.stkobjects.StkObjectRoot.isolate

doc/source/api/ansys/stk/core/stkx.rst

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,6 @@ Summary
3636
:widths: auto
3737

3838

39-
* - :py:class:`~ansys.stk.core.stkx.ExecCmdResult`
40-
- Collection of strings returned by the ExecuteCommand.
41-
42-
* - :py:class:`~ansys.stk.core.stkx.ExecMultiCmdResult`
43-
- Collection of objects returned by the ExecuteMultipleCommands.
44-
4539
* - :py:class:`~ansys.stk.core.stkx.UiAxGraphics3DCntrl`
4640
- AGI Globe control.
4741

@@ -104,18 +98,6 @@ Summary
10498
:widths: auto
10599

106100

107-
* - :py:class:`~ansys.stk.core.stkx.LOG_MESSAGE_TYPE`
108-
- Log message types.
109-
110-
* - :py:class:`~ansys.stk.core.stkx.LOG_MESSAGE_DISP_ID`
111-
- Log message destination options.
112-
113-
* - :py:class:`~ansys.stk.core.stkx.LINE_STYLE`
114-
- Line Style.
115-
116-
* - :py:class:`~ansys.stk.core.stkx.EXEC_MULTI_CMD_RESULT_ACTION`
117-
- Enumeration defines a set of actions when an error occurs while executing a command batch.
118-
119101
* - :py:class:`~ansys.stk.core.stkx.SHIFT_VALUES`
120102
- State of the Shift/Ctrl/Alt keys.
121103

@@ -205,8 +187,6 @@ Solar Panel Tool
205187
:maxdepth: 1
206188
:hidden:
207189

208-
ExecCmdResult<stkx/ExecCmdResult>
209-
ExecMultiCmdResult<stkx/ExecMultiCmdResult>
210190
UiAxGraphics3DCntrl<stkx/UiAxGraphics3DCntrl>
211191
UiAx2DCntrl<stkx/UiAx2DCntrl>
212192
PickInfoData<stkx/PickInfoData>
@@ -231,10 +211,6 @@ Solar Panel Tool
231211
:maxdepth: 1
232212
:hidden:
233213

234-
≔ LOG_MESSAGE_TYPE<stkx/LOG_MESSAGE_TYPE_enum>
235-
≔ LOG_MESSAGE_DISP_ID<stkx/LOG_MESSAGE_DISP_ID_enum>
236-
≔ LINE_STYLE<stkx/LINE_STYLE_enum>
237-
≔ EXEC_MULTI_CMD_RESULT_ACTION<stkx/EXEC_MULTI_CMD_RESULT_ACTION_enum>
238214
≔ SHIFT_VALUES<stkx/SHIFT_VALUES_enum>
239215
≔ BUTTON_VALUES<stkx/BUTTON_VALUES_enum>
240216
≔ OLE_DROP_MODE<stkx/OLE_DROP_MODE_enum>

doc/source/api/ansys/stk/core/stkx/EXEC_MULTI_CMD_RESULT_ACTION_enum.rst

Lines changed: 0 additions & 42 deletions
This file was deleted.

doc/source/api/ansys/stk/core/stkx/ExecCmdResult.rst

Lines changed: 0 additions & 103 deletions
This file was deleted.

doc/source/api/ansys/stk/core/stkx/ExecMultiCmdResult.rst

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)