search

cryptodeal / zigTensor

https://cryptodeal.github.io/zigTensor/
21 stars 0 forks source link

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

Open cryptodeal opened 1 year ago

cryptodeal commented 1 year ago

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 commented 1 year ago

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).