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

Duplicate Ids in HTML Builder with need_extract #1369

Open
kreuzberger opened this issue Dec 10, 2024 · 1 comment
Open

Duplicate Ids in HTML Builder with need_extract #1369

kreuzberger opened this issue Dec 10, 2024 · 1 comment

Comments

@kreuzberger
Copy link
Contributor

kreuzberger commented Dec 10, 2024

Using need_extract to show a "different" view on the need creates an entry in html with same id as the original one.
This leads to "WARNING: Anchor defined twice" in generation of pdf from html with sphinx-simplepdf.

Could there be an option to "prefix" the ID generated in html output, so that the id is generated from the prefix and the "original" id from the requirement? Or how could this be solved.

Or is there an other way to show the content of a need? Dynamic functions are not usefull, cause if they contain rst formats they are not rendered correctly.

What should be achieved

The content of a need should be reused in documentation for SOT principle. This should be achieved by getting the content of the need (rendered, dynamic functions like with needextract)

What does not help

Dynamic functions could return the content, but as text only without any rst parsing or other resolved stuff. Therefore the output is not fully usable.

What could be used

needextract seems to work, but generates several outputs in the document with the same link/reference id. The content is rendered good and could be styled/layouted to integrate into the document text.

@kreuzberger
Copy link
Contributor Author

kreuzberger commented Dec 11, 2024

This is related to #689. Here the idea is to add a flag to REMOVE the id with the option :is_target: false. This could also be a solution.

This was also the intention of the original proposal #66:

Maybe a new, automatic set attribute mirrored: ID would be helpful to identify easily a mirrored need in the final documentation.

Originally posted by @danwos in #66 (comment)

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

No branches or pull requests

1 participant