-
Notifications
You must be signed in to change notification settings - Fork 568
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
Add links from Rust and C++ to the common platform backend docs #3347
Conversation
3fbe83d
to
793f24d
Compare
api/cpp/docs/index.rst
Outdated
Debugging Techniques <../slint/src/advanced/debugging_techniques.html#http://> | ||
Selecting a Widget Style <../slint/src/advanced/style.html#http://> | ||
Platform Backends <../slint/src/advanced/backends.html#http://> |
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.
Can we have comments in .rst and add a comment mentioning sphinx-doc/sphinx#701 (comment) ?
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.
Yes, good point. If we proceed with this, then I'll add that.
To be honnest, i don't think this is required. Because these link are accessible already if one follow "slint documentation" and then gets there. That said, i'm not objecting to this change if you like it this way. |
The main issue I have is that in the C++ and Rust reference we have documentation about the backend feature selection, but we don't link to the platform backend does. I'll try to do that for C++ in I'd also love to do it for the Rust crate feature docs, but I don't know how to do the concat dance in |
So I agree with you, I'll make at least the change for C++ to remove those "misleading" links and try to have the links to the backend docs right in |
Maybe where we talk about the backend, we should link to the relevant documentation |
Good point, this won't work :-/ |
Yep. Any idea how to do that? |
Maybe #[doc = document_features!(ext_link_foo = concat!("https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/slint/blah.html"))] and then in ## This is the [Foo](${ext_link_foo}) backend.
backend-foo = [] Is that possible in terms of the nested macro use? |
... and adjust the C++ platform backend docs a little to the current state. cc #3208
793f24d
to
291bcc6
Compare
New PR has the sidebar links removed, cmake.md overhauled, and just one link added to the "Related Topics" on the Rust side - as a compromise. |
So be my guest if you want to implement that :-)
But honestly, i think this is overdoing it. Either
My preference would be 3. , but i'd accept any other. |
Agreed. So let's go with 5 ;-) : A link under "related topics" |
... and adjust the C++ platform backend docs a little to the current
state.
cc #3208