search

ansys / pyedb-core

Ansys Electronics Database Python Client Package
https://edb.core.docs.pyansys.com/
MIT License
2 stars 1 forks source link

FEATURE: Restructure imports to remove circular imports #400

Closed chenchienjacklin closed 2 months ago

drewm102 commented 3 months ago

@chenchienjacklin Did you confirm that the links to objects in the documentation strings aren't broken by these changes? Some areas refer to the objects by their full path, which I would imagine would no longer work with these change. For example, in database.py the method top_circuit_cells contains the string <ansys.edb.core.layout.Cell>. I believe this would now need to be changed to <ansys.edb.core.layout.cell.Cell>?

@hiro727 Correct me if I'm wrong, but I believe that you found that we can avoid using full paths in the doc strings by just using :class:. followed by the class name like this?:

:class:`.Cell`

hiro727 commented 3 months ago

@hiro727 Correct me if I'm wrong, but I believe that you found that we can avoid using full paths in the doc strings by just using :class:. followed by the class name like this?:

:class:.Cell

@drewm102 yes, see some examples here

@chenchienjacklin you'll also need to adjust the entry .rst files. currently the top level docs are also empty

from the GH action artifact: image