BasPH opened a new issue, #29267:
URL: https://github.com/apache/airflow/issues/29267

   ### What do you see as an issue?
   
   I suggest supporting tabs in the docs to improve the readability when 
demonstrating different ways to achieve the same things.
   
   **Motivation**
   We have multiple ways to achieve the same thing in Airflow, for example:
   
   - TaskFlow API & "classic" operators
   - CLI & REST API & API client
   
   However, our docs currently do not consistently demonstrate different ways 
to use Airflow. For example, 
https://airflow.apache.org/docs/apache-airflow/stable/howto/operator/python.html
 demonstrates TaskFlow operators in some examples and classic operators in 
other examples. All cases covered can be supported by both the TaskFlow & 
classic operators.
   
   In the case of 
https://airflow.apache.org/docs/apache-airflow/stable/howto/operator/python.html,
 I think a nice solution to demonstrate both approaches would be to use tabs. 
That way somebody who prefers the TaskFlow API can view all TaskFlow examples, 
and somebody who prefers the classic operators (we should give those a better 
name) can view only those examples.
   
   **Possible implementation**
   There is a package 
[sphinx-tabs](https://github.com/executablebooks/sphinx-tabs) for this. For the 
example above, having https://sphinx-tabs.readthedocs.io/en/latest/#group-tabs 
would be great because it enables you to view all examples of one "style" with 
a single click.
   
   ### Solving the problem
   
   Install https://github.com/executablebooks/sphinx-tabs with the docs.
   
   ### Anything else
   
   _No response_
   
   ### Are you willing to submit PR?
   
   - [ ] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of 
Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to