Repository navigation
Broken Source Code Links in Operator Guides #23632
Description
What do you see as an issue?
The [source] links in the operator HowTo guides seem to be 404'ing:
(source)
I tried to fix this but got kinda lost in the docs build system.
Solving the problem
I think that sphinx isn't loading the example_dags folder, as these modules aren't found here:
https://airflow.apache.org/docs/apache-airflow/2.3.0/_modules/
While they were present in 2.2.3:
https://airflow.apache.org/docs/apache-airflow/2.2.3/_modules/
Anything else
I can keep looking into this, but would appreciate any pointers or guidance.
Are you willing to submit PR?
- Yes I am willing to submit a PR!
Code of Conduct
- I agree to follow this project's Code of Conduct
Activity
[-]Source Code Links in Operator Guides are 404'ing[/-][+]Broken Source Code Links in Operator Guides[/+]eladkal commentedon May 11, 2022
see #23480
potiuk commentedon May 11, 2022
Yep. Known issue. Maybe time to fix it.
vijaya-lakshmi-venkatraman commentedon May 18, 2022
Hi
I would like to give a try on this if this is not already taken.
Also, request to provide some pointers
potiuk commentedon May 18, 2022
Feel Free! :) Sphinx is a bit mysterious creature and asks many riddles, so any help is more than welcome.
potiuk commentedon May 18, 2022
Some pointers here: apache/airflow-site#536
potiuk commentedon May 18, 2022
And possibly @mik-laj can help
vijaya-lakshmi-venkatraman commentedon May 19, 2022
Thank you.
My understanding from the comment is that between 2.2.3 and the stable (2.3.0) version, the links have stopped working due to some change, possibly in the sphinx.ext.code module.
For the next step, should I be checking how to add a new module to Sphinx?
potiuk commentedon May 19, 2022
I personally do not know :). I have very little knowledge about sphinx. Big part of the task is to find out what to do really because possiblychange in sphinx triggered it but we do not know exactly what was the root cause.
rbiegacz commentedon May 21, 2022
BTW - the links stopped working also for providers. For example, [source] link doesn't work in the page devoted to this operator: https://airflow.apache.org/docs/apache-airflow-providers-google/stable/operators/cloud/automl.html
3 remaining items
Fix links to sources for examples (#24386)
Fix example_dags and system tests "source" links in documentatioN
This is the result of running the scripts from
This is the result of running the scripts from (#613)
Fix links to sources for examples (apache#24386)
This is the result of running the scripts from (#613)