potiuk commented on issue #32295:
URL: https://github.com/apache/airflow/issues/32295#issuecomment-1621160060
> @potiuk @Adaverse I think this is a bigger problem and cannot be fixed
post the docs are generated. This should be fixed in the sphinx config.
>
> Why are we excluding the `example_dags` while building the docs?
>
> ```
> exclude_patterns.extend(
> _get_rst_filepath_from_path(f) for f in
pathlib.Path(PACKAGE_DIR).glob("**/example_dags")
> )
> ```
To be honest. I am not sure. This part has always been a bit
"trial-and-error" - likely because enabling it causes a number of "index.rst is
not part of any TOC". You can remove it and see what efffect it will have.
Likely it will need an index to be generated to those.
I do not think we have good set of "reasoning" in the configuration of those
docs - in some cases the changes were "simplest way to make the docs build" but
without deeper understanding if some of the links there might be missing.
I **think** generally speaking `example_dags` are not considered as public
API of the providers, they are just used as "embedded examples" in the docs -
and you do not need to have the Python AutoAPI generated documentation, but
embedding them using "example include" expects them to be there in the docs.
Just note: example_dags for most cases has been converted to system tests.
There are likely few `example_dags` that are left and possibly, the right
approach will be to move them to system tests.
--
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]
