summaryrefslogtreecommitdiff
path: root/doc/sphinx/maintainers_include.py
AgeCommit message (Collapse)Author
2026-01-19docs: kdoc: handle the obsolescensce of docutils.ErrorString()J. Neuschäfer
The ErrorString() and SafeString() docutils functions were helpers meant to ease the handling of encodings during the Python 3 transition. There is no real need for them after Python 3.6, and docutils 0.22 removes them, breaking the docs build Handle this by just injecting our own one-liner version of ErrorString(), and removing the sole SafeString() call entirely. Reported-by: Zhixu Liu <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Upstream: https://git.kernel.org/linus/00d95fcc4dee66dfb6980de6f2973b32f973a1eb [j.ne: Adapted from Linux to U-Boot] Signed-off-by: J. Neuschäfer <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2024-03-13doc: fix incorrect path DocumentationHeinrich Schuchardt
When copying the build system for Linux we missed to replace some instances of 'Documentation' by 'doc'. Signed-off-by: Heinrich Schuchardt <[email protected]>
2024-03-13doc/sphinx: fix Python string escapesBenjamin Gray
Python 3.6 introduced a DeprecationWarning for invalid escape sequences. This is upgraded to a SyntaxWarning in Python 3.12, and will eventually be a syntax error. Fix these now to get ahead of it before it's an error. Signed-off-by: Benjamin Gray <[email protected]> Message-ID: <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Adapted for U-Boot Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-01-27doc: update Kernel documentation build systemHeinrich Schuchardt
Update the documentation build system according to Linux v5.11-rc1. Deactive the automarkup.py extension module which on Gitlab CI is incompatible with Unicode. With this patch we can build the HTML documentation using either of Sphinx 2 and Sphinx 3. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-01-23Revert "doc: update Kernel documentation build system"Tom Rini
Unfortunately we now see a number of now-fatal warnings about duplicate labels. It is often unclear how best to re-write the document in question to not duplicate these otherwise logical headings. This reverts commit 10a1df3cd43ba2fe893d5dd1aeb2e7109ef0007f. Signed-off-by: Tom Rini <[email protected]>
2021-01-23doc: update Kernel documentation build systemHeinrich Schuchardt
Update the docomentation build system according to Linux v5.11-rc1. With this patch we can build the HTML documentation using either of Sphinx 2 and Sphinx 3. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]> [Fix warning in b4860qds.rst about "Switch Settings"] Signed-off-by: Tom Rini <[email protected]>