Skip to content

Commit

Permalink
Limit astroid version to < 2.12 (#24982)
Browse files Browse the repository at this point in the history
Astroid 2.12 released 9th of July breaks documentation building
with sphinx-autoapi.

Issue about it has been opened in
pylint-dev/astroid#1708

Until it is fixed, we should limit astroid.

(cherry picked from commit ee564ef9e57707ef07db1c3353a1406e47d8e3db)

GitOrigin-RevId: 06e4976aaf3236d06b7e6ec85a796f82718ddfcd
  • Loading branch information
potiuk authored and Cloud Composer Team committed Sep 12, 2024
1 parent ad8e9f9 commit 45ce9aa
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/apache-airflow-providers-github/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ Content

Detailed list of commits <commits>

.. toctree::
:hidden:
:caption: System tests

System Tests <_api/tests/system/providers/github/index>


.. THE REMAINDER OF THE FILE IS AUTOMATICALLY GENERATED. IT WILL BE OVERWRITTEN AT RELEASE TIME!
Expand Down
5 changes: 5 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import unittest
from copy import deepcopy
from os.path import dirname, relpath
from pathlib import Path
from textwrap import wrap
from typing import Dict, List

Expand All @@ -46,6 +47,7 @@

version = '2.3.3'

AIRFLOW_SOURCES_ROOT = Path(__file__).parent.resolve()
my_dir = dirname(__file__)


Expand Down Expand Up @@ -278,6 +280,9 @@ def write_version(filename: str = os.path.join(*[my_dir, "airflow", "git_version
'requests>=2.26.0',
]
doc = [
# Astroid 2.12.* breaks documentation building
# We can remove the limit here after https://github.com/PyCQA/astroid/issues/1708 is solved
'astroid<2.12.0',
'click>=8.0',
'sphinx>=4.4.0',
# Docutils 0.17.0 converts generated <div class="section"> into <section> and breaks our doc formatting
Expand Down

0 comments on commit 45ce9aa

Please sign in to comment.