Add edb::env-switcher
and edb::split-section
sphinx directives
#8218
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.
edb::env-switcher
:This directive is used to mark a group of pages as a single 'logical' page in the docs navigation, within which the user can switch between the content of each rst page using the environment switcher ui. To use create an empty
index.rst
page with this directive at the start, and a toctree containing the nested pages:The name of each nested page must be defined in the env names mapping in the docs site repo.
edb::split-section
:Any page containing at least one of these directives will be rendered with the split layout design. The last child element in the directive must be a
code-block
ortabs
directive, which will be rendered on the right side of the page, and the rest of the content in the directive will be on the left, aligned with the code block. Any other page content not insplit-section
directives will also be rendered on the left.edb::split-point
:Overrides the default behaviour above where the last code block is rendered on the right, and instead explicitly marks the point in the
split-section
after which the content is rendered on the right side of the page. Has an optional arg which can be eitherabove
orbelow
, to pick whether the content before or after thesplit-point
is rendered on the right side of the page (on mobile the order is the same as in the rst)