Fix bibliography alignment for PDF and HTML #148
Merged
Conversation
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
The Sphinx LaTeX writer has its maximum citation label length MAX_CITATION_LABEL_LENGTH set to 8 characters. [1] Larger citations labels cause misalignment in the resulting bibliography for target latexpdf (which we track as issue ARM-software#128). As there is no easy way to change this limit, shorten all our citations labels instead to a maximum of 8 characters and add a word about this limitation in the README. [1] https://github.com/sphinx-doc/sphinx/blob/master/sphinx/writers/latex.py Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
The citations labels of the bibliography are badly aligned for the html and singlehtml output formats (see issue ARM-software#128). Add a custom CSS and use it to adjust the margin. We visually tailor the setting for citations labels of 8 characters maximum, which corresponds to the LaTeX formatter's setting. Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Collaborator
Author
xypron
reviewed
Oct 22, 2025
xypron
suggested changes
Nov 5, 2025
Contributor
xypron
left a comment
xypron
left a comment
There was a problem hiding this comment.
Please, update the links as indicated.
| .. [RVPRIVSPEC] `The RISC-V Instruction Set Manual Volume II: Privileged Architecture | ||
| .. [RVPRVSPC] `The RISC-V Instruction Set Manual Volume II: Privileged Architecture | ||
| <https://github.com/riscv/riscv-isa-manual/releases/download/Priv-v1.12/riscv-privileged-20211203.pdf>`_, |
Contributor
There was a problem hiding this comment.
The current version is 20250508 Date: May 2025, available at https://docs.riscv.org/reference/isa/_attachments/riscv-privileged.pdf
Please, update the link.
| .. [RVSBISPEC] `RISC-V Supervisor Binary Interface specification | ||
| .. [RVSBISPC] `RISC-V Supervisor Binary Interface specification | ||
| <https://github.com/riscv-non-isa/riscv-sbi-doc>`_ |
Contributor
There was a problem hiding this comment.
Please, use https://docs.riscv.org/reference/platform-software/sbi/_attachments/riscv-sbi.pdf which has the latest ratified version (v3.0, 2025-07-16).
Collaborator
Author
|
Accepted during the EBBR call of Nov 5. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is an attempt at fixing #128 (almost).
For the PDF format, the main drawback is that we need to give up on citations labels longer than 8 characters.
Let us please know if this is deemed acceptable; if nobody complains we can merge it.