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

zt.tensor.Tensor docs page leads to 404 #7

Open
cryptodeal opened this issue Sep 27, 2023 · 1 comment
Open

zt.tensor.Tensor docs page leads to 404 #7

cryptodeal opened this issue Sep 27, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@cryptodeal
Copy link
Owner

What version of Zig is running?

0.12.0-dev.601+f4c884617

What platform is your computer?

Darwin 22.6.0 arm64 arm

What steps can reproduce the bug?

Run the following:

zig build docs -DZT_ARRAYFIRE_USE_CPU

What is the expected behavior?

Autodoc should work to generate the docs page for Tensor.

What do you see instead?

Broken link: https://cryptodeal.github.io/zigTensor/#A;zt:tensor.Tensor

Screenshot 2023-09-27 at 3 25 55 AM

Additional information

This could potentially be a bug with zig's autodoc feature, but need to verify that it's not an issue with how the codebase is setup before jumping to any conclusions.

@cryptodeal cryptodeal added the bug Something isn't working label Sep 27, 2023
@cryptodeal cryptodeal pinned this issue Sep 27, 2023
@cryptodeal
Copy link
Owner Author

cryptodeal commented Sep 28, 2023

Was considering whether this could be an issue with the import structure in the project, but after playing around w various methods of imports locally (e.g. separating Tensor Ops into TensorOps.zig and then exporting in tensor.zig namespace as such pub const Tensor = @import("TensorBase.zig").Tensor; I'm still unable to get the docs working locally.

Have posted in #autodoc channel on Zig's discord for help/feedback as I don't want to file an issue on the zig repo if there's a mistake in the project configuration.

Edit: I've pushed an update with cleaned up imports/exports based on lib/std.zig, but still hitting the same issue (should make it easier to review imports in case something there is off/causing this issue).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant