Use tab sets to avoid synchronization of input/ouput tabs in Sphinx #2577
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
Currently, the sphinx inline tab plugin is used for tabs but that synchronizes all tabs with the same label together. When an operation has multiple examples, synchronizing the input and output tabs is not ideal UX.
JordonPhillips
requested changes
Apr 7, 2025
There was a problem hiding this comment.
The motivating example isn't actually a problem. There's only an Input and Output tab right now to showcase that examples are tabbed. Both should be removed entirely when we have actual examples in languages being generated. Each tab then will be a language, and we definitely want those synchronized.
|
I think the use case for the language tabs makes sense. In the meantime, I would not be opposed to merging the change given that tab synchronization was added to sphinx-design as well. |
|
If you want to use the sphinx-design tabs, I'd lean into it by adding an overload that accepts a tab group name so that things sync deliberately. Off the top of my head, both examples and protocols should be synced. |
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.
Background
The current implementation in Smithy-docgen synchronizes all "Input" and "Output" tabs across operation examples, which creates a poor user experience when dealing with multiple examples in Sphinx.
It is not yet possible to avoid tab synchronization without changing the tab labels which in this case are fixed to "Input" and "Output" for all examples.
We can instead use tab sets supported in sphinx-design.
Testing
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.