Uh oh!
There was an error while loading. Please reload this page.
Add support for tabs (and other UX components) to docs - #36041
Conversation
Uh oh!
There was an error while loading. Please reload this page.
josh-fell
commented
Dec 4, 2023
An example of using tabs to display both the TaskFlow API and operator-style in the Python how-to doc: Screen.Recording.2023-12-03.at.10.51.52.PM.mov |
BasPH
left a comment
There was a problem hiding this comment.
This will be a great addition to the docs! One minor comment
Uh oh!
There was an error while loading. Please reload this page.
potiuk
commented
Dec 4, 2023
Oh.. Fantastic ! :) . And you can also rebase now, after the |
498794d to
41a9a8bCompareeladkal
commented
Dec 4, 2023
I noticed that when you change tab the URL stays fixed. |
BasPH
commented
Dec 4, 2023
Don't think it's currently possible. Found this PR: executablebooks/sphinx-design#104 but it's still open |
josh-fell
commented
Dec 4, 2023
I agree with @BasPH. It's not entirely obvious, but maybe it's possible with the other attributes you can set on each item like |
e2986fd to
7e737f2CompareThe latest and greatest version of the Python operators doc. I ended up splitting the Screen.Recording.2023-12-04.at.7.00.17.PM.mov |
Uh oh!
There was an error while loading. Please reload this page.
This PR introduces the [`sphinx-design`](https://sphinx-design.readthedocs.io/en/alabaster-theme/index.html) extension which provides numerous UX components such as tabs, cards, and dropdowns for documentation. There are different ways or flavors of implementing or achieving the same result in Airflow whether that be in configuration, DAG authoring, etc. The current documentation explicitly lists these options as they appear which can lead to some lengthy doc pages as well as inconsistency in their presentation. Any the ability to render these different options for as tabs should combat both the verboseness and inconsistencies.
7e737f2 to
ff1eb7aCompare(cherry picked from commit 58e264c)
This PR introduces the
sphinx-designextension which provides numerous UX components such as tabs, cards, and dropdowns for documentation.There are different ways or flavors of implementing or achieving the same result in Airflow whether that be in configuration, DAG authoring, etc. The current documentation explicitly lists these options as they appear which can lead to some lengthy doc pages as well as inconsistency in their presentation. Adding the ability to render these different options as tabs should combat both the verboseness and inconsistencies.
Closes: #29267