You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "ashb (via GitHub)" <gi...@apache.org> on 2025/03/04 17:58:31 UTC
[PR] Start working on the docs for the Task SDK [airflow]
ashb opened a new pull request, #47357:
URL: https://github.com/apache/airflow/pull/47357
In order to have a nicer experience (i.e. rather than just being given an
alphabetical list of classes/functions) I have chosen to not use the auto
generate feature of the AutoAPI extension, but instead to precisely control
the order and grouping of the classes.
For this to be complete we will likely need some testing that compares the
items on the generated `objects.inv` with the things we re-export from
`airflow/sdk/__init__.py`.
The `airflow/sdk/__init__.pyi` type stub is sadly needed, as without it (and
with the imports only inside the `if TYPE_CHECKING` block) we weren't getting
the re-exported classes showing up where we want them, specifically we want
users to import things directly from airflow.sdk, not the submodule.
It was generated with `stubgen -o task_sdk/src -m airflow.sdk`
Test this with `sphinx-build -b html -Tv task_sdk/docs/ task_sdk/docs/_build`
Closes #43010
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Start working on the docs for the Task SDK [airflow]
Posted by "phanikumv (via GitHub)" <gi...@apache.org>.
phanikumv commented on PR #47357:
URL: https://github.com/apache/airflow/pull/47357#issuecomment-2929112723
We are handling this in #51153
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Start working on the docs for the Task SDK [airflow]
Posted by "phanikumv (via GitHub)" <gi...@apache.org>.
phanikumv closed pull request #47357: Start working on the docs for the Task SDK
URL: https://github.com/apache/airflow/pull/47357
--
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-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org