Skip to content

Commit

Permalink
FEATURE: Fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chenchienjacklin committed Jun 7, 2024
1 parent 47d0c0d commit 37a963c
Show file tree
Hide file tree
Showing 79 changed files with 771 additions and 770 deletions.
73 changes: 39 additions & 34 deletions doc/source/api/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,38 @@ Definition
Classes
-------

.. currentmodule:: ansys.edb.core.definition
.. currentmodule:: ansys.edb.core

.. autosummary::
:toctree: _autosummary

ApdBondwireDef
BondwireDef
ComponentDef
ComponentModel
ComponentPin
DielectricMaterialModel
DynamicLinkComponentModel
DatasetDef
Jedec4BondwireDef
Jedec5BondwireDef
MaterialDef
NPortComponentModel
PackageDef
PadstackDef
PadstackDefData
ThermalModifier
SolderBallProperty
ComponentProperty
ICComponentProperty
IOComponentProperty
RLCComponentProperty
DieProperty
PortProperty
definition.bondwire_def.ApdBondwireDef
definition.bondwire_def.BondwireDef
definition.component_def.ComponentDef
definition.component_model.ComponentModel
definition.component_pin.ComponentPin
definition.dataset_def.DatasetDef
definition.debye_model.DebyeModel
definition.die_property.DieProperty
definition.dielectric_material_model.DielectricMaterialModel
definition.djordjecvic_sarkar_model.DjordjecvicSarkarModel
definition.component_model.DynamicLinkComponentModel
definition.bondwire_def.Jedec4BondwireDef
definition.bondwire_def.Jedec5BondwireDef
definition.material_def.MaterialDef
definition.material_property_thermal_modifier.MaterialPropertyThermalModifier
definition.multipole_debye_model.MultipoleDebyeModel
definition.component_model.NPortComponentModel
definition.package_def.PackageDef
definition.padstack_def.PadstackDef
definition.padstack_def_data.PadstackDefData
definition.material_def.ThermalModifier
definition.solder_ball_property.SolderBallProperty
definition.component_property.ComponentProperty
definition.ic_component_property.ICComponentProperty
definition.io_component_property.IOComponentProperty
definition.rlc_component_property.RLCComponentProperty
definition.port_property.PortProperty


Enums
Expand All @@ -40,13 +44,14 @@ Enums
.. autosummary::
:toctree: _autosummary

DefinitionObjType
BondwireDefType
MaterialProperty
PadType
PadGeometryType
PadstackHoleRange
SolderballShape
SolderballPlacement
DieType
DieOrientation
edb_defs.DefinitionObjType
definition.bondwire_def.BondwireDefType
definition.material_def.MaterialProperty
definition.padstack_def_data.PadType
definition.padstack_def_data.PadGeometryType
definition.padstack_def_data.PadstackHoleRange
definition.padstack_def_data.SolderballShape
definition.padstack_def_data.SolderballPlacement
definition.die_property.DieType
definition.die_property.DieOrientation
definition.dielectric_material_model.DielectricMaterialModelType
16 changes: 8 additions & 8 deletions doc/source/api/geometry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@ Classes
.. autosummary::
:toctree: _autosummary

ArcData
RTree
PolygonData
PointData
Point3DData
Triangle3DData
arc_data.ArcData
r_tree.RTree
polygon_data.PolygonData
point_data.PointData
point3d_data.Point3DData
triangle3d_data.Triangle3DData

Enums
-----

.. autosummary::
:toctree: _autosummary

ExtentType
PolygonSenseType
polygon_data.ExtentType
polygon_data.PolygonSenseType
8 changes: 4 additions & 4 deletions doc/source/api/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,20 @@ Glossary
- :obj:`float`
- :obj:`complex`
- :obj:`str` for expressions ('1nm', 'x + 1' etc)
- :class:`Value <ansys.edb.core.utility.Value>`
- :class:`Value <ansys.edb.core.utility.value.Value>`

Point2DLike

Any of the following data types that represents (x, y) point on a 2D coordinate system.

- :class:`PointData <ansys.edb.core.geometry.PointData>`
- :class:`PointData <ansys.edb.core.geometry.point_data.PointData>`
- (:term:`ValueLike`, :term:`ValueLike`) or any other iterable with 2 :term:`ValueLike` inside

Point3DLike

Any of the following data types that represents (x, y, z) point on a 3D coordinate system.

- :class:`Point3DData <ansys.edb.core.geometry.Point3DData>`
- :class:`Point3DData <ansys.edb.core.geometry.point3d_data.Point3DData>`
- (:term:`ValueLike`, :term:`ValueLike`, :term:`ValueLike`) or any other iterable with 3 :term:`ValueLike` inside

Triangle3DLike
Expand All @@ -63,7 +63,7 @@ Glossary

HFSS solver properties are represented by a tuple of the form [dc_thickness_type, dc_thickness_value, solve_inside_enabled]

(:class:`DCThicknessType <ansys.edb.core.layer.DCThicknessType>`, :term:`ValueLike`, :obj:`bool`)
(:class:`DCThicknessType <ansys.edb.core.layer.stackup_layer.DCThicknessType>`, :term:`ValueLike`, :obj:`bool`)

HFSSExtents

Expand Down
28 changes: 14 additions & 14 deletions doc/source/api/hierarchy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ Object types
.. autosummary::
:toctree: _autosummary

CellInstance
InstArray
ComponentGroup
Group
PinGroup
Model
PinPairModel
NetlistModel
SParameterModel
SPICEModel
Structure3D
ViaGroup
cell_instance.CellInstance
inst_array.InstArray
component_group.ComponentGroup
group.Group
pin_group.PinGroup
model.Model
pin_pair_model.PinPairModel
netlist_model.NetlistModel
sparameter_model.SParameterModel
spice_model.SPICEModel
structure3d.Structure3D
via_group.ViaGroup


Enums
Expand All @@ -33,5 +33,5 @@ Enums
.. autosummary::
:toctree: _autosummary

ComponentType
MeshClosure
component_group.ComponentType
structure3d.MeshClosure
26 changes: 13 additions & 13 deletions doc/source/api/layer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@ Classes
.. autosummary::
:toctree: _autosummary

Layer
StackupLayer
ViaLayer
LayerCollection
layer.Layer
stackup_layer.StackupLayer
via_layer.ViaLayer
layer_collection.LayerCollection

Enums
-----

.. autosummary::
:toctree: _autosummary

LayerType
TopBottomAssociation
DrawOverride
LayerVisibility
DCThicknessType
RoughnessRegion
LayerCollectionMode
LayerTypeSet
DielectricMergingMethod
layer_collection.LayerType
layer.TopBottomAssociation
layer.DrawOverride
layer.LayerVisibility
stackup_layer.DCThicknessType
stackup_layer.RoughnessRegion
layer_collection.LayerCollectionMode
layer_collection.LayerTypeSet
layer_collection.DielectricMergingMethod
14 changes: 7 additions & 7 deletions doc/source/api/layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ Classes
.. autosummary::
:toctree: _autosummary

Cell
Layout
McadModel
PowerModule
VoltageRegulator
cell.Cell
layout.Layout
mcad_model.McadModel
voltage_regulator.PowerModule
voltage_regulator.VoltageRegulator

Enums
-----

.. autosummary::
:toctree: _autosummary

CellType
DesignMode
cell.CellType
cell.DesignMode
10 changes: 5 additions & 5 deletions doc/source/api/layout_instance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Classes
.. autosummary::
:toctree: _autosummary

LayoutInstance
LayoutInstanceContext
LayoutObjInstance
LayoutObjInstance2DGeometry
LayoutObjInstance3DGeometry
layout_instance.LayoutInstance
layout_instance_context.LayoutInstanceContext
layout_obj_instance.LayoutObjInstance
layout_obj_instance.LayoutObjInstance2DGeometry
layout_obj_instance.LayoutObjInstance3DGeometry
8 changes: 4 additions & 4 deletions doc/source/api/net.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Classes
.. autosummary::
:toctree: _autosummary

DifferentialPair
ExtendedNet
Net
NetClass
differential_pair.DifferentialPair
extended_net.ExtendedNet
net.Net
net_class.NetClass
2 changes: 1 addition & 1 deletion doc/source/api/primitive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Primitives
Classes
-------

.. currentmodule:: ansys.edb.core.primitive
.. currentmodule:: ansys.edb.core.primitive.primitive

.. autosummary::
:toctree: _autosummary
Expand Down
96 changes: 48 additions & 48 deletions doc/source/api/simulation_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,58 +9,58 @@ Classes
.. autosummary::
:toctree: _autosummary

HFSSSimulationSettings
HfssSimulationSetup
HFSSGeneralSettings
HFSSSettingsOptions
HFSSSolverSettings
HFSSAdvancedSettings
HFSSAdvancedMeshingSettings
HFSSDCRSettings
AdaptiveFrequency
BroadbandAdaptiveSolution
MatrixConvergenceData
MatrixConvergenceDataEntry
MultiFrequencyAdaptiveSolution
SingleFrequencyAdaptiveSolution
LengthMeshOperation
MeshOperation
SkinDepthMeshOperation
AdvancedMeshingSettings
AdvancedSettings
SettingsOptions
SimulationSettings
SolverSettings
SimulationSetup
SweepData
FreqSweepType
HFSSRegionComputeResource
InterpolatingSweepData
RaptorXSimulationSettings
RaptorXGeneralSettings
RaptorXAdvancedSettings
RaptorXSimulationSetup
SIWaveDCIRSimulationSettings
SIWaveDCIRSimulationSetup
SIWaveSimulationSettings
SIWaveGeneralSettings
SIWaveAdvancedSettings
SIWaveDCSettings
SIWaveDCAdvancedSettings
SIWaveSParameterSettings
SIWaveSimulationSetup
hfss_simulation_settings.HFSSSimulationSettings
hfss_simulation_setup.HfssSimulationSetup
hfss_simulation_settings.HFSSGeneralSettings
hfss_simulation_settings.HFSSSettingsOptions
hfss_simulation_settings.HFSSSolverSettings
hfss_simulation_settings.HFSSAdvancedSettings
hfss_simulation_settings.HFSSAdvancedMeshingSettings
hfss_simulation_settings.HFSSDCRSettings
adaptive_solutions.AdaptiveFrequency
adaptive_solutions.BroadbandAdaptiveSolution
adaptive_solutions.MatrixConvergenceData
adaptive_solutions.MatrixConvergenceDataEntry
adaptive_solutions.MultiFrequencyAdaptiveSolution
adaptive_solutions.SingleFrequencyAdaptiveSolution
mesh_operation.LengthMeshOperation
mesh_operation.MeshOperation
mesh_operation.SkinDepthMeshOperation
simulation_settings.AdvancedMeshingSettings
simulation_settings.AdvancedSettings
simulation_settings.SettingsOptions
simulation_settings.SimulationSettings
simulation_settings.SolverSettings
simulation_setup.SimulationSetup
simulation_setup.SweepData
simulation_setup.FreqSweepType
simulation_setup.HFSSRegionComputeResource
simulation_setup.InterpolatingSweepData
raptor_x_simulation_settings.RaptorXSimulationSettings
raptor_x_simulation_settings.RaptorXGeneralSettings
raptor_x_simulation_settings.RaptorXAdvancedSettings
raptor_x_simulation_setup.RaptorXSimulationSetup
siwave_dcir_simulation_settings.SIWaveDCIRSimulationSettings
siwave_dcir_simulation_setup.SIWaveDCIRSimulationSetup
siwave_simulation_settings.SIWaveSimulationSettings
siwave_simulation_settings.SIWaveGeneralSettings
siwave_simulation_settings.SIWaveAdvancedSettings
siwave_simulation_settings.SIWaveDCSettings
siwave_simulation_settings.SIWaveDCAdvancedSettings
siwave_simulation_settings.SIWaveSParameterSettings
siwave_simulation_setup.SIWaveSimulationSetup

Enums
-----

.. autosummary::
:toctree: _autosummary

SimulationSetupType
AdaptType
BasisFunctionOrder
SolverType
ViaStyle
SParamInterpolation
SParamExtrapolation
SParamDCBehavior
simulation_setup.SimulationSetupType
hfss_simulation_settings.AdaptType
hfss_simulation_settings.BasisFunctionOrder
hfss_simulation_settings.SolverType
simulation_settings.ViaStyle
siwave_simulation_settings.SParamInterpolation
siwave_simulation_settings.SParamExtrapolation
siwave_simulation_settings.SParamDCBehavior
Loading

0 comments on commit 37a963c

Please sign in to comment.