Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Sphinx 5.2 incompatibility #352

Closed
potiuk opened this issue Sep 26, 2022 · 2 comments
Closed

Sphinx 5.2 incompatibility #352

potiuk opened this issue Sep 26, 2022 · 2 comments

Comments

@potiuk
Copy link

potiuk commented Sep 26, 2022

Sphinx autoapi generated docs are incompatible with Sphinx 5.2 and generate deprecation warnings for properties

Example apache-airflow build https://github.com/apache/airflow/actions/runs/3124609849/jobs/5068282271

This example .rst fle generated by Autoapi:

   .. py:method:: providers()
      :property:

      Returns information about available providers.

Produces this warning:

WARNING: Using the :property: flag with the py:method directiveis deprecated, use ".. py:property::" instead.
@potiuk potiuk mentioned this issue Sep 26, 2022
Merged
potiuk added a commit to potiuk/airflow that referenced this issue Sep 26, 2022
@potiuk
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed
0eedc6b 
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
potiuk added a commit to apache/airflow that referenced this issue Sep 26, 2022
@potiuk
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed (…
ba96604 
…#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
@zaneselvans zaneselvans mentioned this issue Sep 26, 2022
Closed
jedcunningham pushed a commit to apache/airflow that referenced this issue Sep 26, 2022
@potiuk @jedcunningham
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed (…
d660595 
…#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)
jedcunningham pushed a commit to apache/airflow that referenced this issue Sep 27, 2022
@potiuk @jedcunningham
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed (…
1f0c017 
…#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)
@potiuk
Copy link
Author

potiuk commented Sep 28, 2022

Thanks! Will test 2.0.0 with airflow in a moment

@potiuk potiuk mentioned this issue Sep 28, 2022
Merged
potiuk added a commit to potiuk/airflow that referenced this issue Sep 28, 2022
@potiuk
Bump sphinx and sphinx-autoapi
ac3d6f8 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.
potiuk added a commit to apache/airflow that referenced this issue Sep 28, 2022
@potiuk
Bump sphinx and sphinx-autoapi (#26743)
9e06c99 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.
@potiuk
Copy link
Author

potiuk commented Sep 28, 2022

Verified that it works with latest Sphinx. Merged it for Airlfow :). Thanks Again for quick fix !

ephraimbuddy pushed a commit to apache/airflow that referenced this issue Oct 18, 2022
@potiuk @ephraimbuddy
Bump sphinx and sphinx-autoapi (#26743)
ba281d6 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.

(cherry picked from commit 9e06c99)
@potiuk potiuk mentioned this issue Jan 3, 2023
Closed
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Jan 30, 2023
@potiuk
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed…
ac7d6b1 
… (#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 ba96604608a4b44b5febf50384b251850c2de62e)

GitOrigin-RevId: 1f0c017eda638d10c4ab4432495dcbc470136b74
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Jan 30, 2023
@potiuk
Bump sphinx and sphinx-autoapi (#26743)
6fb1f4b 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.

(cherry picked from commit 9e06c99f6102d0227c6e7b20b258d628c2bc6d5c)

GitOrigin-RevId: ba281d69afb64faecfc9337f6423bb98904dd0e3
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Mar 30, 2023
@potiuk
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed…
96b1a10 
… (#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

GitOrigin-RevId: ba96604608a4b44b5febf50384b251850c2de62e
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Mar 30, 2023
@potiuk
Bump sphinx and sphinx-autoapi (#26743)
6db847d 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.

GitOrigin-RevId: 9e06c99f6102d0227c6e7b20b258d628c2bc6d5c
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Apr 4, 2023
@potiuk
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed…
d3f31c6 
… (#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

GitOrigin-RevId: ba96604608a4b44b5febf50384b251850c2de62e
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Apr 4, 2023
@potiuk
Bump sphinx and sphinx-autoapi (#26743)
8f810bc 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.

GitOrigin-RevId: 9e06c99f6102d0227c6e7b20b258d628c2bc6d5c
netbsd-srcmastr referenced this issue in NetBSD/pkgsrc May 6, 2023
@0-wiz-0
py-sphinx-autoapi: update to 2.1.0.
cadba75 
v2.1.0 (2023-03-28)
-------------------

Deprecations and Removals
^^^^^^^^^^^^^^^^^^^^^^^^^

- Support for documenting languages other than Python is deprecated. (#248)
- Removed the option to have autoapi generate toctree entries for domain objects.
  Domain objects are now added to the toctree by Sphinx.
  Dropped support for sphinx < 5.2.0. (#369)


Misc
^^^^

- Added basic type checking.
- Integrated towncrier into the release workflow.


v2.0.1 (2023-01-16)
-------------------

Features
^^^^^^^^
- Can turn off the addition of documented objects to the TOC tree.
- Added support for Python 3.11.

Bug Fixes
^^^^^^^^^
- `#330 <https://github.com/readthedocs/sphinx-autoapi/issues/330>`: (Python)
  Render tuple values as tuples, not lists.
- `#341 <https://github.com/readthedocs/sphinx-autoapi/issues/341>`: (Python)
  Fix module level assignments to class attributes being documented as
  module level attributes.
- (Python) Fix "bysource" sort order showing items in alphabetical order.
- (Python) Use the correct directives for a variable type and value.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Removed some autogenerated test data from the repository.


v2.0.0 (2022-09-27)
-------------------

Breaking Changes
^^^^^^^^^^^^^^^^

- Dropped support for Sphinx <4.
- `#352 <https://github.com/readthedocs/sphinx-autoapi/issues/352>`: (Python)
  Properties are rendered with the ``property`` directive,
  fixing support for Sphinx 5.2.
  A new ``PythonPythonMapper`` object (``PythonProperty``) has been created
  to support this change. This object can be passed to templates, filters,
  and hooks.
  A new ``property.rst`` template has also been created to support this change.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Use https links where possible in documentation.
- Pass correct argument types to ``status_iterator``.


V1.9.0 (2022-07-25)
-------------------

Breaking Changes
^^^^^^^^^^^^^^^^

- Dropped support for Python 3.6.

Features
^^^^^^^^

- Added support for Python 3.10.
- `#222 <https://github.com/readthedocs/sphinx-autoapi/issues/222>`:
  Marked extension as parallel read safe.

Bug Fixes
^^^^^^^^^
- `#324 <https://github.com/readthedocs/sphinx-autoapi/issues/324>`: (Python)
  Fail elegantly when no source files are found.
- (Python) Stop calling ``autodoc-process-docstring`` when docstring is empty.
  Works around sphinx-doc/sphinx#10701.
- `#318 <https://github.com/readthedocs/sphinx-autoapi/issues/318>`: (Python)
  Fixed misaligned argument types on methods/classmethods when using type comments.
- `#278 <https://github.com/readthedocs/sphinx-autoapi/issues/278>`: (Python)
  Limit signatures to 60 characters in summaries.
- Fix keyerror when using markdown sources.
- `#328 <https://github.com/readthedocs/sphinx-autoapi/issues/328>`: (Python)
  Fix kw-only marker getting ignored if first in the signature.

Trivial/Internal Changes
^^^^^^^^^^^^^^^^^^^^^^^^
- Fixed tests in Sphinx 5.
- Fixed many typos throughout the documentation.
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Sep 18, 2024
@potiuk
Add limit to Sphinx < 5.2.0 until autoapi incompatibilities are fixed…
c9849d1 
… (#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

GitOrigin-RevId: ba96604608a4b44b5febf50384b251850c2de62e
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Sep 18, 2024
@potiuk
Bump sphinx and sphinx-autoapi (#26743)
ff41e60 
The sphinx-autoapi bug readthedocs/sphinx-autoapi#352
has been resolved and 2.0.0 version has been released. Since we
are using sphinx/sphinx-autoapi only for `doc` extra, we can
safely bump the minimum version of both to latest released minor
versions.

GitOrigin-RevId: 9e06c99f6102d0227c6e7b20b258d628c2bc6d5c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@potiuk