Skip to content

fix(add_docs): populate the full key on options - #99

Open
oraNod wants to merge 1 commit into
ansible-network:masterfrom
oraNod:fix-broken-parameter
Open

fix(add_docs): populate the full key on options#99
oraNod wants to merge 1 commit into
ansible-network:masterfrom
oraNod:fix-broken-parameter

Conversation

@oraNod

@oraNod oraNod commented Aug 20, 2026

Copy link
Copy Markdown

Noticed when reviewing ansible-collections/amazon.ai#54

When generating RST docs with tox -e add_docs the resulting files contain id="parameter-" and href="#parameter-". This results in broken HTML anchor IDs.

This change populates full_key on options before passing them to the template. This ensures that IDs use value.full_key as expected from the template, as seen here:

<div class="ansibleOptionAnchor" id="parameter-{% for part in value.full_key %}@{ part }@{% if not loop.last %}/{% endif %}{% endfor %}"></div>

@oraNod

oraNod commented Aug 20, 2026

Copy link
Copy Markdown
Author

CI failing due to out of date pre-commit hooks. Fixed with #100

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.

1 participant