Skip to content

Conversation

@sunank200
Copy link
Collaborator

@sunank200 sunank200 commented May 14, 2025

This PR is breaking the docs in main with following error:


============================== apache-airflow ==============================
------------------------------ Error   1 --------------------
 WARNING: undefined label: 'config:fab__access_denied_message'

File path: /opt/airflow/airflow-core/docs/<unknown>
------------------------------ Error   2 --------------------
 WARNING: undefined label: 'config:fab__expose_hostname'

File path: /opt/airflow/airflow-core/docs/<unknown>

I’ve updated the Jinja include for the core configuration reference so that it only emits a Sphinx :ref: link when the target section is part of the core docs. For provider‐only options (the new fab ones), it now falls back to plain text rather than linking to an undefined config:fab label. This removes the “undefined label” warnings for fab__access_denied_message and fab__expose_hostname.

As part of PR we missed adding Sphinx anchors for access_denied_message and expose_hostname config options:

Also added two new Sphinx reference labels in providers/fab/docs/configurations-ref.rst:

  • config:fab__access_denied_message
  • config:fab__expose_hostname

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

Copy link
Contributor

@amoghrajesh amoghrajesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a decent fix, lets wait for CI

@sunank200 sunank200 changed the title Add condition for section move in docs docs: conditionally render section‐move links in sections‐and‐options include May 14, 2025
@sunank200 sunank200 marked this pull request as ready for review May 14, 2025 07:50
@sunank200 sunank200 requested a review from vincbeck as a code owner May 14, 2025 07:50
@eladkal
Copy link
Contributor

eladkal commented May 14, 2025

I merge this one quickly in hope this fix the issue as I have to unblock providers release

@eladkal eladkal merged commit 39f215f into apache:main May 14, 2025
41 of 43 checks passed
@potiuk
Copy link
Member

potiuk commented May 14, 2025

Nice

Copy link
Contributor

@amoghrajesh amoghrajesh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@sunank200 sunank200 deleted the fab-docs-fix branch May 14, 2025 08:34
@vatsrahul1001
Copy link
Contributor

Thanks @sunank200

@pierrejeambrun
Copy link
Member

pierrejeambrun commented May 14, 2025

Should this be backported to v3-0-test ? I'm experiencing the same on backport PRs?

#50544

pierrejeambrun pushed a commit to astronomer/airflow that referenced this pull request May 14, 2025
… include (apache#50582)

* Add condition for section move in docs

* docs(fab): add Sphinx anchors for access_denied_message and expose_hostname config options

(cherry picked from commit 39f215f)
pierrejeambrun added a commit that referenced this pull request May 14, 2025
… (#50544)

* Move access_denied_message webserver config to fab (#50208)

* Move access_denied_message webserver config to fab

* Fix CI

* Update to fab 2.0.3

* Change core to 3.0.2

* fab depends on apache-airflow 3.0.2

* Fix CI

(cherry picked from commit a18a1df)

* Fix CI

* docs: conditionally render section‐move links in sections‐and‐options include (#50582)

* Add condition for section move in docs

* docs(fab): add Sphinx anchors for access_denied_message and expose_hostname config options

(cherry picked from commit 39f215f)

---------

Co-authored-by: Ankit Chaurasia <8670962+sunank200@users.noreply.github.com>
kaxil pushed a commit that referenced this pull request Jun 3, 2025
… (#50544)

* Move access_denied_message webserver config to fab (#50208)

* Move access_denied_message webserver config to fab

* Fix CI

* Update to fab 2.0.3

* Change core to 3.0.2

* fab depends on apache-airflow 3.0.2

* Fix CI

(cherry picked from commit a18a1df)

* Fix CI

* docs: conditionally render section‐move links in sections‐and‐options include (#50582)

* Add condition for section move in docs

* docs(fab): add Sphinx anchors for access_denied_message and expose_hostname config options

(cherry picked from commit 39f215f)

---------

Co-authored-by: Ankit Chaurasia <8670962+sunank200@users.noreply.github.com>
sanederchik pushed a commit to sanederchik/airflow that referenced this pull request Jun 7, 2025
… include (apache#50582)

* Add condition for section move in docs

* docs(fab): add Sphinx anchors for access_denied_message and expose_hostname config options
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants