ebbr
ebbr copied to clipboard
ARM-software
Request-for-comments about adding version annotations
In chapter 1 we say that:
new requirements will be clearly documented as being over and above what was required by a previous release.
We have started to do so in the index history table, but we could also add more explicit annotations nearer to the concerned chapters using specific annotations as shown here.
This is a request-for-comments, to fuel discussions, and is not to be merged.
Please give your feedback in this pull request.
Having the version information at the end of each chapter requires a lot of scrolling. Please, place the information above the referenced element.
versionadded makes some sense. But versionchanged does not tell what the change was. Could be a typo fix or a big change.
The HTML output uses CSS class "versionmodified". You can use it CSS to have the versionadded information in smaller type and in a different color. See https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html. For PDF output see https://www.sphinx-doc.org/en/master/latex.html.
