summaryrefslogtreecommitdiff
path: root/doc/sphinx
AgeCommit message (Collapse)Author
2026-02-06doc: Remove pip from requirements.txtTom Rini
Our documentation does not require the pip package to build, so it should not be listed in our requirements.txt file here. Signed-off-by: Tom Rini <[email protected]> Acked-by: Heinrich Schuchardt <[email protected]>
2026-01-19doc: Update urllib3 version for buildingTom Rini
The GitHub dependabot tool has reported one "high" priority bug, CVE-2026-21441, with this package. Update to the patched version. Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]>
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]>
2025-12-08doc: Update urllib3 version for buildingTom Rini
The GitHub dependabot tool has reported two "high" priority bugs, CVE-2025-66418 and CVE-2025-66471, with this package. Update to the patched version. Reported-by: GitHub dependabot Acked-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2025-07-18python: requirements.txt: Update a few modules for security issuesTom Rini
The GitHub dependabot tool has reported a number of issues recently with some modules that we use. While unlikely to be exploitable in the way we use them, update various libraries to the latest. Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]>
2025-05-11doc: Start improving our pytest documentationTom Rini
Begin the work of documenting all of our pytests. To do this, we should have a directory under develop for it as there will be a large number of new files. As the current document is referenced externally in a number of locations, add the sphinx_reredirects module so that we can redirect from the old location to the new. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-10-30doc: update Python requirementsHeinrich Schuchardt
Update Sphinx, sphinx-rtd-theme, and their dependencies. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-07-14doc/sphinx/requirements.txt: Bump certifi and urllib3Tom Rini
As reported by GitHub dependabot, both of these packages should be bumped to their latest versions to address security issues (neither of which has a CVE assigned). Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-06-30doc: update requirements.txtHeinrich Schuchardt
Update all required Python packages to current release. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-06-10doc/sphinx, test/py: Update requests module to 2.32.2Tom Rini
The issue described in https://github.com/psf/requests/pull/6655 has been assigned as a security issue. While unlikely to be exploited in our usage, update to the current release to fix it. Furthermore, upstream has now moved on to v2.23.2 as the release to use which has all of the issues resolved. Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]>
2024-05-13doc/sphinx: Bump Jinja2 to 3.1.4Tom Rini
While we unlikely to have an issue with CVE-2024-22195, it is simple enough to bump our version of Jinja2 to receive the fix, do so. Reported-by: GitHub dependabot Tested-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2024-04-13doc/sphinx: Bump idna to 3.7Tom Rini
While we unlikely to have an issue with CVE-2024-3651, it is simple enough to bump our version of idna to receive the fix, do so. Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]> Tested-by: Heinrich Schuchardt <[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]>
2024-01-17doc: update requirements.txtHeinrich Schuchardt
Update requirements.txt to most current packages as produced by python3 -m pip install six sphinx-rtd-theme sphinx-prompt python3 -m pip freeze Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2024-01-17docs/sphinx: Explicitly convert Sphinx paths to strOliver Faso
Sphinx 7.2+ is switching to using pathlib.Path instead of str to represent paths. This fixes the current deprecation warnings and eventual breakage. This conversion will be a no-op when using older Sphinx versions. Signed-off-by: Oliver Faso <[email protected]> Tested-by: Akira Yokosawa <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-11-20docs: Fix the docs build with Sphinx 6.0Jonathan Corbet
Sphinx 6.0 removed the execfile_() function, which we use as part of the configuration process. They *did* warn us... Just open-code the functionality as is done in Sphinx itself. Tested (using SPHINX_CONF, since this code is only executed with an alternative config file) on various Sphinx versions from 2.5 through 6.0. Reported-by: Martin Liška <[email protected]> Cc: [email protected] Signed-off-by: Jonathan Corbet <[email protected]> Rebased for U-Boot Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-10-27sphinx: Bump urllib3 versionTom Rini
While unlikely to be a direct issue for us, urllib3 before 2.0.7 is vulnerable to CVE-2023-45803, so bump our version up. Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2023-10-12sphinx: Bump urllib3 versionTom Rini
While not a direct issue for us, urllib3 before 1.26.17 is vulnerable to CVE-2023-43804 to bump our version up. Reported-by: GitHub dependabot Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]> Use urllib3 2.0.6 Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-08-27doc: sphinx: Add sphinx-promptNishanth Menon
Sphinx-prompt[1] helps bring-in '.. prompt::' option that allows a better rendered documentation, yet be able to copy paste without picking up the prompt from rendered documentation. [1] https://lore.kernel.org/all/[email protected]/ Suggested-by: Mattijs Korpershoek <[email protected]> Signed-off-by: Nishanth Menon <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]>
2023-08-15doc/sphinx/requirements.txt: Bump certifi upTom Rini
Upgrade certifi to the latest version, to remove e-Tugra from the root store. Link: https://groups.google.com/a/mozilla.org/g/dev-security-policy/c/C-HrP1SEq1A?pli=1 Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-07-28doc: update doc/sphinx/requirements.txtHeinrich Schuchardt
Update the following requirements to their latest version: * Pygments - syntax highlighting * pytz - world timezone definitions * certifi - Mozilla's CA bundle Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-06-20python: Update requirements.txt for security issuesTom Rini
Per GitHub Dependabot: - Use setuptools 65.5.1 to avoid some DoS issue - Use requests 2.31.0 to avoid leaking some proxy information Signed-off-by: Tom Rini <[email protected]> Tested-by: Heinrich Schuchardt <[email protected]>
2022-12-17doc: update Sphinx requirements for certifiHeinrich Schuchardt
Upgrade to version 2022.12.7. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-03-25doc: update doc/sphinx/requirements.txtHeinrich Schuchardt
Pin all dependencies as reported by 'pip freeze'. Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-01-15.readthedocs.yml: update the requirementsHeinrich Schuchardt
Fix an error: This project needs at least Sphinx v2.4.4. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-10-21doc: require Sphinx 3.4.3Heinrich Schuchardt
For enums documented according to the requirements in chapter "Structure, union, and enumeration documentation" of https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html errors occur with Sphinx 2.4.4 which disappear with Sphinx 3.4.3, e.g. /builds/u-boot/custodians/u-boot-efi/doc/api/sysreset:6: ./include/sysreset.h:60:Unknown interpreted text role "enum". Sphinx 3.4.3 is the version used by Debian in the current release. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-08-14doc: require Sphinx 2.4.4Heinrich Schuchardt
Require Sphinx 2.44 to build the documentation. Remove all code related to earlier versions. Signed-off-by: Heinrich Schuchardt <[email protected]>
2021-04-04sphinx: Pin to docutils-0.16Tom Rini
In newer docutils writers/latex2e/docutils.sty has a unicode character in the comments which can in turn cause Python 3.6 at least to fail. Pin to the previous docutils release for now. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[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]>
2020-10-14doc: Sphinx.override_domain() deprecatedHeinrich Schuchardt
Sphinx.override_domain() is deprecated since Sphinx 1.8 and removed in Sphinx 3. Use Sphinx.add_domain(, override=True) instead. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-04-27doc: sphinx: refresh parse-headers.pl from LinuxHeinrich Schuchardt
Copy parse-headers.pl from Linux kernel tree: * fix the parameter description %s/--man/--usage/ * fix a documentation reference Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-04-24doc: invalid doc link in rstFlatTable.pyHeinrich Schuchardt
Remove an invalid documentation link in rstFlatTable.py. This synchronizes the file with Linux next-20200413. Signed-off-by: Heinrich Schuchardt <[email protected]>
2020-02-24doc: update doc/sphinx/kerneldoc.pyHeinrich Schuchardt
Update doc/sphinx/kerneldoc.py from Linux next-20200219 to avoid warnings like: doc/sphinx/kerneldoc.py:125: RemovedInSphinx20Warning: AutodocReporter is now deprecated. Use sphinx.util.docutils.switch_source_input() instead. self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter) Signed-off-by: Heinrich Schuchardt <[email protected]>
2019-07-24doc: Cope with Sphinx logging deprecationsJonathan Corbet
Recent versions of sphinx will emit messages like: doc/sphinx/kerneldoc.py:103: RemovedInSphinx20Warning: app.warning() is now deprecated. Use sphinx.util.logging instead. Switch to sphinx.util.logging to make this unsightly message go away. Alas, that interface was only added in version 1.6, so we have to add a version check to keep things working with older sphinxes. Signed-off-by: Jonathan Corbet <[email protected]> Rebased for U-Boot Signed-off-by: Heinrich Schuchardt <[email protected]>
2019-06-20doc: Remove duplicated documentation directoryBreno Matheus Lima
Commit ad7061ed742e ("doc: Move device tree bindings documentation to doc/device-tree-bindings") moved all device tree binding documentation to doc/device-tree-bindings directory. The current U-Boot project still have two documentation directories: - doc/ - Documentation/ Move all documentation and sphinx files to doc directory so all content can be in a common place. Signed-off-by: Breno Lima <[email protected]>