-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Bump sphinx-autoapi to >=1.5 #20013
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.
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
Bump sphinx-autoapi to >=1.5 #20013
Conversation
d306365 to
d684139
Compare
Now that we're upgradaing autoapi we can entirely avoid run_patched_sphinx.py s the work-around we are applying is included. |
f43c6ed to
49eced3
Compare
|
The PR most likely needs to run full matrix of tests because it modifies parts of the core of Airflow. However, committers might decide to merge it quickly and take the risk. If they don't merge it quickly - please rebase it to the latest main at your convenience, or amend the last commit of the PR, and push it with --force-with-lease. |
|
cc @mik-laj |
|
Just one watchout - I am afraid many more changes are needed for that. As far as I remember there was a problem with Sphinx-autoapi support related to namespace packages (but I remember it vaguely) and there are some workarounds and sphinx patching https://github.com/apache/airflow/blob/main/docs/exts/docs_build/run_patched_sphinx.py to make it works. So upgrading autoapi might turn into much bigger task than you think (but I believe it is a long overdue one so maybe worth doing it). |
|
AH I see @ashb already commented about it. |
|
In the past, I worked on upgrade for sphinx-autoapi. https://github.com/apache/airflow/pull/15206/files. but I didn't have enough power to finish it. |
|
Ugh, I give up. Let’s just hide the overloaded definitions from autoapi. (Why are we using autoapi in the first place?) |
Now there are 4 of us that gave up after trying. Do I see a pattern here? (and yeah @mik-laj - why do we use autoapi ?) |
|
It was the only tool I found at the moment that generated files for each class without having to manually create the files. We too were constrained by RTD. |
|
There’s a new effort in #20079. |
We need at least 1.5.0 for
typing.overloadsupport, but I’m relaxing to include all future 1.x because why not. See #20011.