Add version annotations #157
Conversation
|
Thanks a lot @vstehle to address this topic. To me it looks like the tags version-added and version-changed are not quite used as intended by Sphinx. The brief description field, as I understand it, is meant to describe the delta and should not contain the normative text. Probably we will have to tweek CSS to put this non-normative into a grey box. |
|
Hi, to follow-up with our EBBR call of Jan 14, I have made the following changes:
I find it less intrusive, even at the source text level. I will try to propose alternate formatting in other pull requests for our next EBBR call of Jan 28 if time permits. |
|
Recalculated the annotations color for HTML to be precisely between white and normal text (not quite black with the theme we use). |
By default version annotations have no special formatting when rendered with Sphinx and LaTeX as pdf, while they are in displayed in italic in the HTML. Customize the LaTeX pdf formatting to render version annotations in italic for consistency. Also, for both the HTML and pdf, render version annotations in gray to make them visibly different from normal text. This has no visible impact until we have version annotations. Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Add version annotations for new and updated requirements, starting from the last EBBR major revision (v2.0.0). Add a few words in the README about version annotations. Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
|
Moved color adjustment to the first commit. |
xypron
left a comment
xypron
left a comment
There was a problem hiding this comment.
LGTM. I did not check the individual version numbers.
|
Thanks @xypron for reviewing, merge after our EBBR call of Jan 28. |
2 participants
This is an attempt at adding version annotations.
Please have a look and let me know how you like it.
This is related with #156 and #118.