[FEATURE] Support index generation (genindex) - #1358
Open
linawolf wants to merge 1 commit into
Open
Conversation
linawolf
force-pushed
the
feature/index-generation
branch
2 times, most recently
from
August 23, 2026 12:03
1b020f9 to
a66855a
Compare
linawolf
changed the title
linawolf
force-pushed
the
feature/index-generation
branch
from
August 23, 2026 12:06
a66855a to
e6b625d
Compare
Sphinx-authored documentation -- including TYPO3 Core's own Changelog files -- relies on `.. index::` entries so readers can jump straight to every page a term is discussed on, the way a printed book's index does. This library parsed those entries but threw them away, so porting such docs here meant silently losing that navigation aid. Entries are now collected project-wide and made available as a genindex page, so documentation migrated from Sphinx keeps working the way its authors intended. Each term is also stamped onto the section it belongs to as a data attribute, independent of any genindex page. That's for tooling that crawls the rendered HTML rather than the reST source -- a custom search engine such as TYPO3's Elasticsearch integration can pick up the same terms an author already tagged with `index`, instead of reimplementing that logic itself. Closes #921 Assisted-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Y48g2S9Q2uUVLcsTEAeyGX Signed-off-by: linawolf
linawolf
force-pushed
the
feature/index-generation
branch
from
August 23, 2026 12:07
e6b625d to
0b33897
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sphinx-authored documentation -- including TYPO3 Core's own Changelog
files -- relies on
.. index::entries so readers can jump straight toevery page a term is discussed on, the way a printed book's index does.
This library parsed those entries but threw them away, so porting such
docs here meant silently losing that navigation aid.
Entries are now collected project-wide and made available as a genindex
page, so documentation migrated from Sphinx keeps working the way its
authors intended.
Each term is also stamped onto the section it belongs to as a data
attribute, independent of any genindex page. That's for tooling that
crawls the rendered HTML rather than the reST source -- a custom search
engine such as TYPO3's Elasticsearch integration can pick up the same
terms an author already tagged with
index, instead of reimplementingthat logic itself.
Closes #921
Assisted-By: Claude Sonnet 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01Y48g2S9Q2uUVLcsTEAeyGX
Signed-off-by: linawolf