Skip to content

Commit

Permalink
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed (
Browse files Browse the repository at this point in the history
…#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 readthedocs/sphinx-autoapi#352

(cherry picked from commit ba96604)
  • Loading branch information
potiuk authored and jedcunningham committed Sep 26, 2022
1 parent b68fb09 commit d660595
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion setup.py
Expand Up @@ -270,7 +270,11 @@ def write_version(filename: str = str(AIRFLOW_SOURCES_ROOT / "airflow" / "git_ve
'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',
Expand Down

0 comments on commit d660595

Please sign in to comment.