Automate links to configuration of providers

[potiuk]

Body

Since more and more providers release their configuration, we should automate generation of the links to the configuration.

See #34305

Committer

• I acknowledge that I am a maintainer/committer of the Apache Airflow project.

[Jyoticharan]

I am beginner in the field of open source and interested to work on this issue,please assign me the issue.

[hussein-awala]

@Jyoticharan sure, I assigned you.

[eladkal]

@Jyoticharan are you still working on this issue?

[poorvirohidekar]

@potiuk - I am interested in working on this. Can you please assign it to me?

Could you help me understand this issue description?
I built the docs in my local for a provider and could find the configuration.rst file. Can you tell me how this relates to the generation of the links to the configuration?

[hussein-awala]

@poorvirohidekar assigned you.

[potiuk]

@poorvirohidekar - similarly to what has beein implemented for automatically retrieving operators/hooks and other references here https://github.com/apache/airflow/blob/main/docs/exts/operators_and_hooks_ref.py - this file adds sphinx directives that are called by sphinx when placed in the .rst files and the code can scan for configurations in provider.yaml files and generate the list from there - we need a new directive there.

[poorvirohidekar]

@potiuk - So from the provider.yaml file, I see that we generate https://airflow.apache.org/docs/apache-airflow-providers-amazon/stable/configurations-ref.html doc. When you say "automate links", do you mean the links that have been done as a part of this PR as an example - #34305 ?

[potiuk]

When you say "automate links", do you mean the links that have been done as a part of this PR as an example - #34305 ?

Precisely. This is what https://github.com/apache/airflow/blob/main/docs/exts/operators_and_hooks_ref.py do with some other entitites.

[poorvirohidekar]

@potiuk - Understood. Thank you

[poorvirohidekar]

@potiuk - From the file mentioned, I understand that class AuthConfigurations is rendering a template configurations.rst.jinja2 and when I look at the configurations.rst.jinja2 file (https://github.com/apache/airflow/blob/main/docs/exts/templates/configuration.rst.jinja2), there is a way in which a similar pattern of link seems to be getting generated? I am not sure if this AuthConfigurations is the relevant existing directive for this issue.
If not, then can you help me understand how the links currently being generated or point me in the right direction?

[potiuk]

Ah. So it's alreeady done 🤦