Skip to content

Fixing fab doc generation on main #50586

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

Closed
amoghrajesh wants to merge 2 commits into from
Closed

Fixing fab doc generation on main #50586

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
6615a56
Fixing fab doc generation on main
amoghrajesh May 14, 2025
529b96b
trying to fix templating
amoghrajesh 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
14 changes: 12 additions & 2 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 @@ -20,6 +20,7 @@
:depth: 1

.. jinja:: config_ctx
{% set seen_labels = [] %}

{% for section_name, section in configs.items() %}

Expand All @@ -37,7 +38,11 @@
{% endif %}

{% for option_name, option in section["options"].items() %}
.. _config:{{ section_name }}__{{ option_name }}:
{% set label = section_name ~ '__' ~ option_name %}
{% if label not in seen_labels %}
.. _config:{{ label }}:
{% do seen_labels.append(label) %}
{% endif %}

{{ option_name }}
{{ "-" * option_name|length }}
Expand Down Expand Up @@ -95,7 +100,12 @@
{% if section_name in deprecated_options %}

{% for deprecated_option_name, (new_section_name, new_option_name, since_version) in deprecated_options[section_name].items() %}
.. _config:{{ section_name }}__{{ deprecated_option_name }}:
{% set label = section_name ~ '__' ~ deprecated_option_name %}
{% if label not in seen_labels %}
.. _config:{{ label }}:
{% do seen_labels.append(label) %}
{% endif %}


{{ deprecated_option_name }} (Deprecated)
{{ "-" * (deprecated_option_name + " (Deprecated)")|length }}
Expand Down
4 changes: 2 additions & 2 deletions providers/fab/docs/configurations-ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

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

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

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