Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEATURE: Restructure imports to remove circular imports #400

Merged
merged 6 commits into from
Jun 12, 2024

Conversation

chenchienjacklin
Copy link
Collaborator

No description provided.

@drewm102
Copy link
Collaborator

@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
Copy link
Contributor

hiro727 commented May 30, 2024

@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

@chenchienjacklin chenchienjacklin merged commit 2cabcff into main Jun 12, 2024
25 checks passed
@chenchienjacklin chenchienjacklin deleted the F398_jlin_dev_0 branch June 12, 2024 17:34
drewm102 pushed a commit that referenced this pull request Jul 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants