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

Links in function signatures not being resolved #2289

Open
dstansby opened this issue Oct 2, 2024 · 3 comments
Open

Links in function signatures not being resolved #2289

dstansby opened this issue Oct 2, 2024 · 3 comments
Labels
documentation Improvements to the documentation V3 Affects the v3 branch

Comments

@dstansby
Copy link
Contributor

dstansby commented Oct 2, 2024

In the v3 docs, there are some internal references that aren't being linked in function signatures. For example, in the listing for zarr.Array, there should be a link for zarr.storage.StoreLike but there isn't. This is despite there being an entry for zarr.storage.StoreLike.

@dstansby dstansby added V3 Affects the v3 branch documentation Improvements to the documentation labels Oct 2, 2024
@dstansby
Copy link
Contributor Author

dstansby commented Oct 2, 2024

StoreLike is showing up fine in the inventory, so I think the issue must be sphinx(-autoapi??) not inserting a cross link properly.

% python -m sphinx.ext.intersphinx _build/html/objects.inv | grep "StoreLike"
    zarr.storage.StoreLike                                                           : _autoapi/zarr/storage/index.html#zarr.storage.StoreLike
    zarr.storage.common.StoreLike                                                    : _autoapi/zarr/storage/common/index.html#zarr.storage.common.StoreLike

@dstansby
Copy link
Contributor Author

dstansby commented Oct 2, 2024

In docs/_autoapi/zarr/storage/index.rst StoreLike is being documented as

.. py:data:: StoreLike

@dstansby
Copy link
Contributor Author

dstansby commented Oct 2, 2024

I think we're running into sphinx-doc/sphinx#10785 here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements to the documentation V3 Affects the v3 branch
Projects
None yet
Development

No branches or pull requests

1 participant