-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
[autodoc] undefined reference for aliased type annotation in the class constructor #12286
Comments
FWICT, it's because we don't have a reference to |
i'm not sure i understand what you mean. Here's the constructor: class State:
"""State object for Sphinx Graph vertices."""
def __init__(
self,
vertices: dict[str, tuple[int, Info]],
graph: rx.PyDiGraph[str, str | None],
) -> None:
"""Create a new state object."""
self._vertices = vertices
self._graph = graph
|
Yes, but that's the issue with the "target not found" of The reason why it says "docstring of State" is because we generate the "docstring" from the init method + its signature but its signature contains some |
sorry, i still don't understand. Can you explain like i'm 5? ;) |
ultimately this is in service to this PR (that i could also use your help on @picnixz!) - danieleades/sphinx-graph#142 |
I assume you are using autodoc. So the documenter generates an (temporary) RST document that would look like:
Then, we want to "highlight"
Go in verbose mode and check the autodoc output (the log starts with "[autodoc] output"). Check what is really being changed so that I can tell you the real issue. Also, could you tell me if I could have perhaps introduced an error in #12256 ? (i.e., could you bissect the bad commit if possible?)
Sorry I don't have much time for that for the next weeks. |
here is the verbose output from the logs:
|
Ah! actually, I just remembered but... did you include the intersphinx mappings for your |
the rustworkx package is installed in the build environment, and imported like so- import rustworkx as rx what additional config is needed to make this discoverable? |
Err, either intersphinx or There are various reasons I can think of why it fails:
And you can fix it by:
Sorry, but I won't have more time today :( |
this doesn't help, unfortunately
yes, i am using this statement |
I am also seeing this issue here - danieleades/sphinx-graph#143 |
Describe the bug
i'm seeing a build error because
rx.PyDiGraph
cannot be foundHow to Reproduce
see https://github.com/danieleades/sphinx-graph/actions/runs/8684807082/job/23813057033?pr=143
Environment Information
Sphinx extensions
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: