PR: Rename signatures module to array_api#430
Conversation
|
Thanks, Stephannie! That's quick. Let me try the patch locally later tonight. |
|
Hi @steff456 and all, I hope you don't mind, I just pushed 9a25cdf to make sure the flattened namespace is accessible by intersphinx. The fact that with this change our own documentation is also using the flattened namespace means that we're testing it ourselves before publishing. A command line check is this: $ python -m sphinx.ext.intersphinx _build/html/objects.invIt should list what functions, attributes, etc are accessible to intersphinx and their corresponding hyperlinks. |
|
Not sure why but the CI hits a permission issue...? |
Ah OK, I also hit this issue before. It's because this GH action dislikes PRs from forking branches... I think this is ready for review. |
|
This can also be useful for verifying this https://github.com/bskinn/sphobjinv |
|
Yeah they will, but that shouldn't block the merging here. We pin the array-api repo with a submodule so we can update it independently. |
leofang
left a comment
There was a problem hiding this comment.
Giving my 👍 despite I also worked on this PR 🙂
|
Thanks, everyone! |
|
Continue the discussion back in the original issue #428. |
This PR,
signaturesmodule toarray_api__init__.pyto provide a flat namespace of all the core modules (extensions are not included)With these changes I'm still not able to use the flat namespace name in the references when rendering with sphinx, but it should work if you are importing the module from your documentation @leofang. Please let me know if it works!
Fixes #428