Skip to content

fix(admin): restore proper anchor IDs for APCu, Redis and Memcached sections#14907

Merged
skjnldsv merged 1 commit into
masterfrom
fix/caching-heading-ids
May 20, 2026
Merged

fix(admin): restore proper anchor IDs for APCu, Redis and Memcached sections#14907
skjnldsv merged 1 commit into
masterfrom
fix/caching-heading-ids

Conversation

@skjnldsv
Copy link
Copy Markdown
Member

@skjnldsv skjnldsv commented May 19, 2026

☑️ Resolves

Summary

The APCu, Redis, and Memcached section headings on the memory caching page were generating
non-descriptive HTML IDs (id1, id2, ...) instead of the expected anchors
(#apcu, #redis, #memcached). This broke direct links to those sections.

Root cause: the bullet-list entries at the top of the page used named external hyperlink
references (`APCu <url>`_). A trailing single underscore in RST creates a named
target — consuming "apcu", "redis", and "memcached" before the section headings are
processed. Sphinx then falls back to sequential IDs (id1, id2, …) for the headings.

Fix: change those three inline links to anonymous references (double underscore
`APCu <url>`__). Anonymous refs do not register a named target, so the section
headings can claim the correct IDs.

Before: caching_configuration.html#id1, #id2
After: caching_configuration.html#apcu, #redis, #memcached

🖼️ Screenshots

No visual layout change — heading text is unchanged, only anchor IDs are fixed.

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes (N/A — text only)
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues

@skjnldsv skjnldsv requested a review from miaulalala May 19, 2026 10:35
@skjnldsv skjnldsv self-assigned this May 19, 2026
@skjnldsv skjnldsv enabled auto-merge May 19, 2026 10:35
@skjnldsv skjnldsv force-pushed the fix/caching-heading-ids branch from ea9d453 to 21f64c0 Compare May 19, 2026 13:42
@skjnldsv skjnldsv disabled auto-merge May 19, 2026 13:59
APCu, Redis, and Memcached h2 headings on the memory caching page were
generating non-descriptive IDs (id1, id2, ...) instead of the expected
anchors (apcu, redis, memcached). Adding explicit RST reference labels
ensures stable, predictable fragment URLs.

Also fix a double-space typo in the existing _install_redis_label
directive that made it malformed RST.

Fixes #6878

Signed-off-by: skjnldsv <skjnldsv@protonmail.com>
@skjnldsv skjnldsv force-pushed the fix/caching-heading-ids branch from 21f64c0 to 0eae533 Compare May 19, 2026 14:17
@skjnldsv skjnldsv changed the title fix(admin): add explicit RST labels to caching configuration headings fix(admin): restore proper anchor IDs for APCu, Redis and Memcached sections May 19, 2026
@skjnldsv skjnldsv enabled auto-merge May 19, 2026 14:33
@github-actions
Copy link
Copy Markdown
Contributor

📖 Documentation Preview

🔍 Open preview →

📄 1 changed documentation page

Last updated: Wed, 20 May 2026 00:42:08 GMT

@skjnldsv skjnldsv merged commit f2465c3 into master May 20, 2026
25 checks passed
@skjnldsv skjnldsv deleted the fix/caching-heading-ids branch May 20, 2026 00:42
@skjnldsv
Copy link
Copy Markdown
Member Author

/backport to stable34

@skjnldsv
Copy link
Copy Markdown
Member Author

/backport to stable33

@skjnldsv
Copy link
Copy Markdown
Member Author

/backport to stable32

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing heading IDs on memory caching page

2 participants