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

Test that docs build on CI #335

Closed
martin-t opened this issue Dec 15, 2021 · 2 comments · Fixed by #336
Closed

Test that docs build on CI #335

martin-t opened this issue Dec 15, 2021 · 2 comments · Fixed by #336

Comments

@martin-t
Copy link

Currently the docs are broken https://docs.rs/crate/tensorflow/0.17.0

Idk what the issue is but it should be noted that docs.rs uses nightly. You can look at a hopefully properly implemented GH action for example here

@dskkato
Copy link
Contributor

dskkato commented Dec 16, 2021

The reason the docs in docs.rs is broken is due to limited network access: see #255. Currently, the doc is posted to github.io

Still, I think it is nice to have doc test in GitHub CI. We already have build-check for the doc via test-all though.

rust/test-all

Lines 55 to 56 in e4f9134

run cargo doc -vv --features tensorflow_unstable
run cargo doc -vv --features tensorflow_unstable,private-docs-rs

@dskkato
Copy link
Contributor

dskkato commented Dec 17, 2021

I am still not sure why issue #255 is not resolved, even though the private-docs-rs feature was introduced to avoid downloading large files when building docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants