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

Several broken links in backend/internal documentation #341

Closed
isislovecruft opened this issue Jan 8, 2021 · 3 comments
Closed

Several broken links in backend/internal documentation #341

isislovecruft opened this issue Jan 8, 2021 · 3 comments
Labels
do-for-4.0 This should be resolved before we do a 4.0 release documentation good first issue

Comments

@isislovecruft
Copy link
Member

#283 fixes a few of them but I think there's more since the repo restructuring last year. I don't have access to the buckets hosting the http://doc-internal.dalek.rs pages, so I'm not able to update them.

@rozbb rozbb added the do-for-4.0 This should be resolved before we do a 4.0 release label Oct 18, 2022
@pinkforest
Copy link
Contributor

Parallel doc

README.md:[parallel_doc]: https://doc-internal.dalek.rs/curve25519_dalek/backend/vector/avx2/index.html
src/lib.rs://! [parallel_doc]: https://doc-internal.dalek.rs/curve25519_dalek/backend/vector/avx2/index.html

Questions / Findings

  1. This is hard-coded to doc-internal.dalek.rs - not relative link
  2. dalek.rs is just doing make doc and make doc-internal using nightly toolchain I'm assuming ?
  3. Should this continue to rely on dalek.rs or should it moved to docs.rs generated as other crates ?

make doc issue

[target/doc/curve25519_dalek/]backend/vector documentation doesn't get generated -

If continuing to use this method to generate docs is preferred -

Problem is some documentation is behind some unstable feature flags

Which would need to be in RUSTDOCFLAGS which does not honor RUSTFLAGS which I didn't see set either

I can get the backend/vector to generate:

RUSTDOCFLAGS="-C target_feature=+avx2" cargo rustdoc --features "nightly std simd_backend" -- --html-in-header docs/assets/rustdoc-include-katex-header.html --document-private-items

Also I noticed that there are `#[cfg(rustdoc)] in places but this isn't used anymore

This probably should move to doc_cfg pattern

#![feature(doc_cfg)]
#[doc(cfg(feature = "xx"))]

docs.rs ?

Should the docs move to docs.rs ? For this would have to setup docsrs e.g.

[package.metadata.docs.rs]
# document all features
all-features = true
# defines the configuration attribute `docsrs`
rustdoc-args = ["--cfg", "docsrs"]

@pinkforest
Copy link
Contributor

pinkforest commented Nov 25, 2022

Fixed in #439

Validating all the links with lychee

@pinkforest
Copy link
Contributor

This was fixed via #439 @rozbb

@rozbb rozbb closed this as completed Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-for-4.0 This should be resolved before we do a 4.0 release documentation good first issue
Projects
None yet
Development

No branches or pull requests

3 participants