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.

Sign up for GitHub

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

Jump to bottom

Make rustdoc links work with the book #136

Merged
merged 3 commits into from
Jul 27, 2024
Merged

Make rustdoc links work with the book #136

merged 3 commits into from
Jul 27, 2024

Conversation

mondeja
Copy link
Contributor

@mondeja mondeja commented Jul 27, 2024 •
edited
Loading

This PR contains the following changes:

  • Fix all warnings building the rustdoc documentation. Mostly internal crossreferenced urls. To make them work with the book, a new Python function has been added to the post_build.py script, which rewrites the urls in the generated HTML files.
  • Rename BreakpointsSematic to BreakpointsSemantic and breakpoints_sematic to breakpoints_semantic (note the n). This is a breaking change.

@mondeja mondeja changed the title Make rustdocs links work with the book Make rustdoc links work with the book Jul 27, 2024
@mondeja mondeja marked this pull request as draft July 27, 2024 16:30
@mondeja mondeja marked this pull request as ready for review July 27, 2024 16:38
@maccesch maccesch merged commit 017d868 into Synphonyte:main Jul 27, 2024
0 of 2 checks passed
@maccesch
Copy link
Contributor

Thank you very much! Nice work!

@mondeja mondeja deleted the fix-docs-bare-urls branch July 27, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mondeja @maccesch