Skip to content
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.

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

[BUGFIX] Make links to special objects prefixable #932

Merged
merged 2 commits into from
Mar 23, 2024
Merged

Conversation

linawolf
Copy link
Contributor

If we have both an anchor like '.. _demo:' and
a confval of the same name we would get duplicate id's and the links to those two elements could not be distinguished. Sphinx solves this by prefixing all confval links with "confval-".

Therefore I introduces the possibility of prefixing links to destinguished linkable objects.

related #924

releases: main, 1.0

@linawolf linawolf requested a review from jaapio March 16, 2024 10:59
@linawolf linawolf self-assigned this Mar 16, 2024
@linawolf linawolf marked this pull request as draft March 17, 2024 11:57
@linawolf linawolf marked this pull request as ready for review March 17, 2024 17:24
linawolf added a commit to TYPO3-Documentation/render-guides that referenced this pull request Mar 18, 2024
phpDocumentor/guides#945 will take care of duplicates. :name: can then be used to set an individual anchor if there are duplicates

phpDocumentor/guides#932 takes care of the missing link prefix
linawolf added a commit to TYPO3-Documentation/render-guides that referenced this pull request Mar 18, 2024
phpDocumentor/guides#945 will take care of duplicates. :name: can then be used to set an individual anchor if there are duplicates

phpDocumentor/guides#932 takes care of the missing link prefix
typo3-documentation-team pushed a commit to TYPO3-Documentation/t3docs-typo3-docs-theme that referenced this pull request Mar 18, 2024
phpDocumentor/guides#945 will take care of duplicates. :name: can then be used to set an individual anchor if there are duplicates

phpDocumentor/guides#932 takes care of the missing link prefix
Copy link
Member

@jaapio jaapio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wauw... what an ugly hack to make this work. But as it is compatible with sphinx let's do it this way.

I do wonder if I saw something that's not working as expected but it's a bit hard to see just based on the code.

If we have both an anchor like '.. _demo:' and
a confval of the same name we would get duplicate id's and the links to those two elements could not be distinguished. Sphinx solves this by prefixing all confval links with "confval-".

Therefore, I introduce the possibility of prefixing links to distinguished linkable objects.

related #924

releases: main, 1.0
@linawolf linawolf merged commit 3ef4ee0 into main Mar 23, 2024
38 checks passed
@linawolf linawolf deleted the bugfix/confval branch March 23, 2024 08:34
@phpdoc-bot
Copy link

💚 All backports created successfully

Status Branch Result
1.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

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.

3 participants