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

Fix broken doc link #96

Closed
LukePearson1 opened this issue Jan 27, 2022 · 5 comments · Fixed by #103
Closed

Fix broken doc link #96

LukePearson1 opened this issue Jan 27, 2022 · 5 comments · Fixed by #103
Labels
P-medium Priority: medium T-bug Type: bug T-refactor Type: cleanup/refactor

Comments

@LukePearson1
Copy link
Contributor

LukePearson1 commented Jan 27, 2022

The broken link is coming from the plonk-book. We need investigation into why it won't work.

At the moment it is a blocker so we will ignore the infra-link on the PR's

cc: @CPerezz @mathcrypto @markulf

@LukePearson1 LukePearson1 added P-medium Priority: medium T-bug Type: bug T-refactor Type: cleanup/refactor labels Jan 27, 2022
@CPerezz
Copy link
Contributor

CPerezz commented Jan 27, 2022

Which link are you referring to exactly? The one where the book has to be uploaded?

@markulf
Copy link
Collaborator

markulf commented Jan 28, 2022

I noticed a broken Makefile that still refers to docs/katex-header.html and makes make doc fail.

Is this the same issue?

@markulf
Copy link
Collaborator

markulf commented Jan 28, 2022

@CPerezz @LukePearson1 I will also fix the broken conflict in the README if that's ok:

Around Examples.

@markulf markulf linked a pull request Jan 28, 2022 that will close this issue
@markulf
Copy link
Collaborator

markulf commented Jan 29, 2022

CI checks / Intra-doc links (pull_request) still fails.

Documenting plonk v0.8.2 (/home/runner/work/plonk/plonk)
thread 'rustc' panicked at 'no entry found for key', src/librustdoc/passes/collect_intra_doc_links.rs:929:16
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

error: internal compiler error: unexpected panic
Error: internal compiler error: unexpected panic
error: Unrecognized option: 'crate-version'
Error: Unrecognized option: 'crate-version'
error: could not document `plonk`
Error: could not document `plonk`
Caused by:
  process didn't exit successfully: `rustdoc --edition=2021 --crate-type lib --crate-name plonk src/lib.rs -o /home/runner/work/plonk/plonk/target/doc --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat -C metadata=ef6029efed173aea -L dependency=/home/runner/work/plonk/plonk/target/debug/deps --extern plonk_core=/home/runner/work/plonk/plonk/target/debug/deps/libplonk_core-4b8a6fd339527d4c.rmeta --extern plonk_hashing=/home/runner/work/plonk/plonk/target/debug/deps/libplonk_hashing-0c96a82c1e7093d4.rmeta --crate-version 0.8.2` (exit status: 1)
Error: The process '/home/runner/.cargo/bin/cargo' failed with exit code 101

Is this related to this issue? rust-lang/docs.rs#1632

After running rustup update, I can now also reproduce this locally.

@markulf
Copy link
Collaborator

markulf commented Feb 4, 2022

Just do document the outcome. I this was fixed by @davidnevadoc by pinning rustup and thus rustdoc to a slightly older version. I suppose this means that we need to take care that it doesn't get too old (and too painful to be uptodate).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P-medium Priority: medium T-bug Type: bug T-refactor Type: cleanup/refactor
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants