potiuk commented on code in PR #29200: URL: https://github.com/apache/airflow/pull/29200#discussion_r1091017025
########## docs/apache-airflow/public-airflow-interface.rst: ########## @@ -245,24 +245,17 @@ Executors are the mechanism by which task instances get run. All executors are derived from :class:`~airflow.executors.base_executor.BaseExecutor`. There are several executor implementations built-in Airflow, each with its own unique characteristics and capabilities. -Airflow has a set of Executors that are considered public. You are free to extend their functionality -by extending them: - -.. toctree:: - :includehidden: - :glob: - :maxdepth: 1 - - _api/airflow/executors/index Review Comment: The error means that even if the documentation is autogenerated, there is no link to lead to the document. So it's not discoverable (even if generated). And yeah if we want to keep link to BaseExecutor to work - it will not work to exclude everything from executors/* because the class doc will be missing. I guess better to include the link back (maybe inline it when you talk about the other executors). But ... we do not really want to make K8S executors docstring publicly documented if they are not part of the public interface, do we? I think that's anoth K8S / Celery other executors will be (possibly?) moved to providers - https://lists.apache.org/thread/kwwhz62lddygodpgr3fk4b9tthtld9do, the problem will be solved (as executors package might only contain BaseExecutor, or we could even move it out). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
