Change absolute link to relative link during doc generation #8641
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I saw the CI failed. The failed part is on anvil, but my commit is about doc part. Anyone can help me review it? @DaniPopes |
Evalir
reviewed
Aug 15, 2024
crates/doc/src/builder.rs
Outdated
Comment on lines
451
to
453
| .to_string() | ||
| .trim_start_matches('/') | ||
| .to_string(); |
There was a problem hiding this comment.
any chance we can avoid the double allocation here?
|
@DaniPopes @mattsse @Evalir Can you review the code? |
mattsse
reviewed
Sep 19, 2024
crates/doc/src/builder.rs
Outdated
Comment on lines
448
to
456
| let readme_path = Path::new("/") | ||
| .join(&path) | ||
| .display() | ||
| .to_string() | ||
| .trim_start_matches('/') | ||
| .to_owned(); | ||
| let slash_count = readme_path.chars().filter(|&c| c == '/').count(); | ||
| let prefix = "../".repeat(slash_count); | ||
| let readme_path = format!("{prefix}{readme_path}/index.html"); |
There was a problem hiding this comment.
@mattsse Thanks for the comment. I optimized the code in the new commit. The code here transform the path into a relative path which can be used in a web server.
// Generate a relative path to "index.html" based on the current directory depth and
let name = path.iter().last().unwrap().to_string_lossy();
let depth = path.components().count();
let mut prefix = PathBuf::new();
for _ in 0..depth {
prefix.push("..");
}
let readme_path = prefix.join(&path).join("index.html");
let readme_path_str = readme_path.to_string_lossy();
readme.write_link_list_item(&name, &readme_path_str, 0)?;
self.write_summary_section(summary, &files, Some(&path), depth + 1)?;
crates/doc/src/builder.rs
Outdated
Comment on lines
448
to
452
| let readme_path = Path::new("/") | ||
| .join(&path) | ||
| .display() | ||
| .to_string() | ||
| .trim_start_matches('/') |
There was a problem hiding this comment.
this step seems redundant because we first join then remove the leading /
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Closes #8576 This issue found a link problem in forge doc generated website. Some link uses the absolute link like /contracts/foo which is an invalid URL.
Solution
There are two parts using the wrong absolute link
"/contracts/foo"to"../../../contracts/foo"contracts/consensus/authority/): delete the beginning"/", add some"../", addindex.htmlat the end.I tested this PR on cartesi/rollups-contracts. You can view the doc website