search

readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
432 stars 128 forks source link

Sphinx 5.2 incompatibility #352

Closed potiuk closed 2 years ago

potiuk commented 2 years ago

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 commented 2 years ago

Thanks! Will test 2.0.0 with airflow in a moment

potiuk commented 2 years ago

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