Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eladkal merged 2 commits into from
May 14, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8cf636
Add condition for section move in docs
sunank200 May 14, 2025
1f775d5
docs(fab): add Sphinx anchors for access_denied_message and expose_ho…
sunank200 May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions devel-common/src/sphinx_exts/includes/sections-and-options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,11 @@
{{ "-" * (deprecated_option_name + " (Deprecated)")|length }}

.. deprecated:: {{ since_version }}
{% if new_section_name in configs %}
The option has been moved to :ref:`{{ new_section_name }}.{{ new_option_name }} <config:{{ new_section_name }}__{{ new_option_name }}>`
{% else %}
The option has been moved to ``{{ new_section_name }}.{{ new_option_name }}``
{% endif %}
{% endfor %}
{% endif %}

Expand Down
4 changes: 4 additions & 0 deletions providers/fab/docs/configurations-ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,8 @@
under the License.

.. include:: /../../../devel-common/src/sphinx_exts/includes/providers-configurations-ref.rst

.. _config:fab__access_denied_message:
.. _config:fab__expose_hostname:

.. include:: /../../../devel-common/src/sphinx_exts/includes/sections-and-options.rst
Loading