Ajay9704 commented on issue #60185:
URL: https://github.com/apache/airflow/issues/60185#issuecomment-3717946538
Hey folks! I've looked into this issue and figured out what's causing the
problem with BaseSensorOperator not being clickable in the documentation.
**What I found:**
The issue is that BaseSensorOperator is defined in the new Task SDK (at
airflow/task-sdk/src/airflow/sdk/bases/sensor.py), but when the documentation
gets built for providers, it only scans the current provider's source code and
doesn't include the task-sdk. So when a provider like standard sensors
references BaseSensorOperator, the documentation system can't create a proper
link to it because it doesn't know where the class is actually defined.
**My solution:**
I've updated the provider documentation configuration (in
airflow/devel-common/src/docs/provider_conf.py) to:
1. Include the task-sdk source directory when building provider
documentation so it can find SDK classes
2. Add proper intersphinx mapping to link to task-sdk documentation
3. Make sure there are no conflicts between the different documentation
sources
**What this fixes:**
Now BaseSensorOperator will be clickable in provider documentation like the
BashSensor page
Users can easily navigate to see all the inherited parameters like
poke_interval, timeout, mode, etc.
The documentation gap where sensor parameters were hard to find is now closed
I've submitted a PR that implements this fix. The changes are pretty minimal
and only touch the documentation generation system - no runtime code is
affected. This should make it much easier for users to understand sensor
parameters and how they work.
--
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]
