You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by je...@apache.org on 2022/09/26 16:57:55 UTC
[airflow] 01/02: Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed (#26670)
This is an automated email from the ASF dual-hosted git repository.
jedcunningham pushed a commit to branch v2-4-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit d660595eb25af012e944364072d85f2f7ca4dc1a
Author: Jarek Potiuk <ja...@potiuk.com>
AuthorDate: Mon Sep 26 10:30:57 2022 +0200
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed (#26670)
The new (released 2 days ago) Sphinx 5.2.0 introduced deprecation
for he way properties are documented and sphinx-autoapi needs
to catch-up with it. Until that, we limit Sphinx to < 5.2.0
Tracked in https://github.com/readthedocs/sphinx-autoapi/issues/352
(cherry picked from commit ba96604608a4b44b5febf50384b251850c2de62e)
---
setup.py | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/setup.py b/setup.py
index 2ef361b964..6312f7a658 100644
--- a/setup.py
+++ b/setup.py
@@ -270,7 +270,11 @@ doc = [
'sphinx-copybutton',
'sphinx-jinja>=2.0',
'sphinx-rtd-theme>=0.1.6',
- 'sphinx>=4.4.0',
+ # Spinx 5.2.0 introduced deprecation for property documentation and autoapi 1.9.0 generates
+ # documentation that uses the old way of documenting it. This is tracked in
+ # https://github.com/readthedocs/sphinx-autoapi/issues/352 of autoapi and until it is solved
+ # we need to limit Sphinx to <5.2.0
+ 'sphinx>=4.4.0,<5.2.0',
'sphinxcontrib-httpdomain>=1.7.0',
'sphinxcontrib-redoc>=1.6.0',
'sphinxcontrib-spelling>=7.3',