Update toolchain availability reference #42
Conversation
The shared links document is unused, because it requires reStructuredText to use. We use myST which does not have a similar feature. The document was just part of the Canonical Sphinx docs starter pack. Signed-off-by: Dominik Viererbe <[email protected]>
Seperate the reference of available versions for the toolchains into seperate documents by toolchain. This commit also applies minor updates to the availability matracies. Signed-off-by: Dominik Viererbe <[email protected]>
Add a smalll reference outlining the .NET backports and previews PPA. Signed-off-by: Dominik Viererbe <[email protected]>
Signed-off-by: Dominik Viererbe <[email protected]>
|
Thanks, @dviererbe. Maybe we could use Matt's suggestion to have the toolchain availability under tabs like the IDE reference? I'm guessing a separate page for every toolchain might not be necessary. |
|
@rkratky I started out with Tabs, but ref linking is a bit weird with tabs. |
There was a problem hiding this comment.
Thank you, @dviererbe (and apologies for the delay). Added some comments.
It should work with defining a sync key: https://sphinx-design.readthedocs.io/en/latest/tabs.html?category=key2#synchronised-tabs
|
issue: Yes, it is possible to manually create a link like that to link to a heading within a tab item , but this does not work properly with dynamic links using the Let's take this small example: If I now want to link to the llvm sub heading (on the 2nd tab) using this syntax ¹ actually it will show you the tab that you last visited, which is the first tab (.NET in this example). This behaviour in combination with dynamic linking is even more confusing. |
Ah, right. You obviously thought this through much more than I have ;) OK, point taken -- it'll be better to have indiv. pages/files. |
Remove the row with the links to the toolchain availability pages from the index page of the docs. This is based on the feedback of our technical author Robert Krátký: > I think extending the table this way is not necessary -- let's keep > the landing page uncluttered. While the reference info is useful, it's > not the main content of the docs set. I'd like the table to link > (only) to the two basic topics: > - how to get the toolchains > - how to start using them Co-authored-by: Robert Krátký <[email protected]> Signed-off-by: Dominik Viererbe <[email protected]>
Move the reference for valid components and versions to install to the .NET availability reference and link to it from the how-to/dotnet-setup article. Signed-off-by: Dominik Viererbe <[email protected]>
Replace the <span> elements to use a custom css class by defining a spinx role and using this instead. This makes the source text much more readable and maintainable. Signed-off-by: Dominik Viererbe <[email protected]>
Instead of using a custom default-package role to highlight the llvm-default version in orange, we replace it by using a sperate row that shows the default version. This was suggested by Robert Krátký. Co-authored-by: Robert Krátký <[email protected]> Signed-off-by: Dominik Viererbe <[email protected]>
A previous commit accidentially removed a `|` from index.md at the end of a table column. Signed-off-by: Dominik Viererbe <[email protected]>
Updates the toolchain availability reference