Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for tabs (and other UX components) to docs #36041

Merged
merged 7 commits into from
Dec 6, 2023
Merged

Add support for tabs (and other UX components) to docs #36041

merged 7 commits into from
Dec 6, 2023

Commits on Dec 5, 2023

  1. Add support for tabs (and other UX components) to docs 

    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.
    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    ab09a4a View commit details
    Browse the repository at this point in the history

  2. Set lower bound for sphinx-design

    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    735aa59 View commit details
    Browse the repository at this point in the history

  3. Split example DAGs and add doc consistency

    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    132c7be View commit details
    Browse the repository at this point in the history

  4. fixup! Split example DAGs and add doc consistency

    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    7e8f087 View commit details
    Browse the repository at this point in the history

  5. Fix test_task_instance_endpoint tests

    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    5e4292b View commit details
    Browse the repository at this point in the history

  6. Fix :sync: key for PythonOperator tab

    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    1712a51 View commit details
    Browse the repository at this point in the history

  7. Move function creation outside of loop in example DAGs

    @josh-fell
    josh-fell committed Dec 5, 2023
    Configuration menu
    Copy the full SHA
    ff1eb7a View commit details
    Browse the repository at this point in the history