-
-
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
Use of TypeVar results in "reference target not found" error #10974
Comments
I think this is actually the same problem that is reported in #10785. And more generally it seems that using something as a type hint that isn't documented as |
This PR fixes the following minor errors and aspects in the documentation. 1. The `Smiles` type alias introduced in `parameters.substance`. This type alias is manually configured in `conf.py`. In order to avoid the documentation to load all of the attributes and functions of `str`, the templates were changed slightly to not include those, resulting in the output shown at the end. 2. The generics in `baybe.utils.basic`. Sphinx behaves weird when using generics (see sphinx-doc/sphinx#10974). Thus, an exception was included in the nitpick_ignore dictionary, eliminating the error. 3. The order of the examples in the table of contents as well as the level of displayed headings was adjusted
Sphinx does not seem to resolve these correctly and with nitpick mode on, Sphinx will produce an error. See sphinx-doc/sphinx#10974.
Sphinx does not seem to resolve these correctly and with nitpick mode on, Sphinx will produce an error. See sphinx-doc/sphinx#10974.
I am also hitting this with annotations using e.g. |
Describe the bug
Simple example below.
The
TypeVar
seems to get converted intopy:data
and thus we get an error when the type info in the signature or description tries to link to apy:class
for it.How to Reproduce
With the below files in a folder, run
sphinx-build -Eanb html . build/
index.rst
conf.py
repro.py
Environment Information
Sphinx extensions
autodoc
Additional context
No response
The text was updated successfully, but these errors were encountered: