-
Notifications
You must be signed in to change notification settings - Fork 412
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
Implement codegen of doclinks #6850
Conversation
Deployed docs
|
Does this add |
If the links are relative, maybe I don't have to 😬 |
To get |
Ok, Probably best to review all this commit-by commit |
all_objects: &Objects, | ||
kind: ObjectKind, | ||
order: u64, | ||
prelude: &str, | ||
objects: &[&Object], |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: some unfortunate naming: all_objects
and objects
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, I gave up here
What
You can now write doclinks in the docstrings of our
.fbs
files. Example:The links will be transformed to the appropriate form for the codegen target (Rust doclinks are different from those of Python, C++/doxygen, and website/markdown).
Only links to types are currently supported.
Link checking is not done by the codegen, but the output is checked implicityly by
cargo doc
,lychee
etc.Checklist
main
build: rerun.io/viewernightly
build: rerun.io/viewerCHANGELOG.md
and the migration guideTo run all checks from
main
, comment on the PR with@rerun-bot full-check
.