Usage¶
Basics¶
Tabs are created, using a tab directive. Consecutive tab directives create a single set of tabs.
This is text before the tabs.
.. tab:: One
One is an interesting number.
.. tab:: Two
Two is the even prime.
.. tab:: Three
Three is an odd prime.
.. tab:: Four
Four is not a perfect number.
This is text after the tabs, which seems to flow right through, which avoids breaking the flow of the document.
This is text before the tabs.
One is an interesting number.
Two is the even prime.
Three is an odd prime.
Four is not a perfect number.
This is text after the tabs, which seems to flow right through. There is no visual difference for content that’s within a tab vs outside it – adding tabs doesn’t disrupt the flow of the document.
Multiple Tab Sets¶
It is possible to start a new set from a tab, by having some content between sets or by providing :new-set: option to the tab directive.
.. tab:: One
One is an interesting number.
.. tab:: Two
Two is the even prime.
This will break the tab set!
.. tab:: Three
Three is an odd prime.
.. tab:: Four
Four is not a perfect number.
.. tab:: Five
:new-set:
Five is a nice number.
.. tab:: Six
Six is also nice.
One is an interesting number.
Two is the even prime.
This will break the tab set!
Three is an odd prime.
Four is not a perfect number.
Five is a nice number.
Six is also nice.
Rich tab labels¶
This is only possible with Markdown, as far as I know.
```{tab} Three
Three is an odd prime.
```
```{tab} Four (equal to $2^2$)
Four is not a perfect number.
```
Three is an odd prime.
Four is not a perfect number.
Code Tabs¶
The first code block in a tab content will “join” with the tabs, making things fairly clean for language snippets and OS-based command suggestions.
print("Hello World!")
It’s pretty simple!
#include <iostream>
int main() {
std::cout << "Hello World!" << std::endl;
}
More code, but it works too!
Hello World!
Why not.
Synchronisation¶
Tabs across multiple sets are synchronised according to the label, unconditionally. This requires JavaScript to be enabled on the end user’s browser and, thus, should be considered a progressive enhancement.
Hint
Nearly all usage of tabbed content in documentation is based on something about the user which stays consistent throughout the reading (like their OS, or preferred language etc). That’s why this behaviour is unconditional.
$ py -m pip install sphinx
$ python -m pip install sphinx
$ make.bat html
$ make html
Nesting¶
New in version 2020.04.11.beta8.
Tabs can be nested, allowing the creation of decision trees made with tabs. Nested tabs are also synchronised.
cmd.exe
ps2.exe
As can be seen on the other tab, the tab sets will “join” when there’s no text between different levels of tabs. Adding text between them will space them out.
bash
zsh
fish
ps2