Fix missing models in API documentation. #31021
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
References to the modules are added to the public interface docs now (to make sure they are linked to from somewhere):
And they have API generated:
I hand-picked those models that are truly public: |
ephraimbuddy
approved these changes
May 2, 2023
The Airflow models have been accidentally removed from the docs when apache#28300 was implemented. The whole models documentation have been removed accidentally, even if there were references to the actual classes and packages used as the models package was entirely excluded. This PR fixes it by selectively including the models that should be included and by linking the package indexes directly in the public interface documentation.
potiuk
force-pushed
the
fix-missing-models-in-documentation
branch
from
ede42de to
03762ee
Compare
ephraimbuddy
pushed a commit
that referenced
this pull request
May 2, 2023
The Airflow models have been accidentally removed from the docs when #28300 was implemented. The whole models documentation have been removed accidentally, even if there were references to the actual classes and packages used as the models package was entirely excluded. This PR fixes it by selectively including the models that should be included and by linking the package indexes directly in the public interface documentation. (cherry picked from commit 6720a90)
2 tasks
ephraimbuddy
added
the
type:misc/internal
34 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The Airflow models have been accidentally removed from the docs when #28300 was implemented. The whole models documentation have been removed accidentally, even if there were references to the actual classes and packages used as the models package was entirely excluded.
This PR fixes it by selectively including the models that should be included and by linking the package indexes directly in the public interface documentation.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.