summaryrefslogtreecommitdiff
path: root/doc/sphinx
AgeCommit message (Collapse)AuthorFilesLines
2024-07-14doc/sphinx/requirements.txt: Bump certifi and urllib3Tom Rini1-2/+2
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 <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-06-30doc: update requirements.txtHeinrich Schuchardt1-8/+8
Update all required Python packages to current release. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2024-06-10doc/sphinx, test/py: Update requests module to 2.32.2Tom Rini1-1/+1
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 <trini@konsulko.com>
2024-05-13doc/sphinx: Bump Jinja2 to 3.1.4Tom Rini1-1/+1
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 <xypron.glpk@gmx.de> Signed-off-by: Tom Rini <trini@konsulko.com>
2024-04-13doc/sphinx: Bump idna to 3.7Tom Rini1-1/+1
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 <trini@konsulko.com> Tested-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-13doc: fix incorrect path DocumentationHeinrich Schuchardt1-4/+4
When copying the build system for Linux we missed to replace some instances of 'Documentation' by 'doc'. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-03-13doc/sphinx: fix Python string escapesBenjamin Gray4-7/+7
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 <bgray@linux.ibm.com> Message-ID: <20230912060801.95533-3-bgray@linux.ibm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Adapted for U-Boot Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-01-17doc: update requirements.txtHeinrich Schuchardt1-22/+21
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 <heinrich.schuchardt@canonical.com> Reviewed-by: Tom Rini <trini@konsulko.com>
2024-01-17docs/sphinx: Explicitly convert Sphinx paths to strOliver Faso2-2/+2
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 <erer1243@gmail.com> Tested-by: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230910040811.53046-1-erer1243@gmail.com Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-11-20docs: Fix the docs build with Sphinx 6.0Jonathan Corbet1-2/+4
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 <mliska@suse.cz> Cc: stable@vger.kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net> Rebased for U-Boot Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-10-27sphinx: Bump urllib3 versionTom Rini1-1/+1
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 <trini@konsulko.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-10-12sphinx: Bump urllib3 versionTom Rini1-1/+1
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 <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org> Use urllib3 2.0.6 Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-27doc: sphinx: Add sphinx-promptNishanth Menon1-0/+1
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/87fs48rgto.fsf@baylibre.com/ Suggested-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Signed-off-by: Nishanth Menon <nm@ti.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-15doc/sphinx/requirements.txt: Bump certifi upTom Rini1-1/+1
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 <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-07-28doc: update doc/sphinx/requirements.txtHeinrich Schuchardt1-3/+3
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 <heinrich.schuchardt@canonical.com>
2023-06-20python: Update requirements.txt for security issuesTom Rini1-1/+1
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 <trini@konsulko.com> Tested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2022-12-17doc: update Sphinx requirements for certifiHeinrich Schuchardt1-1/+1
Upgrade to version 2022.12.7. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-03-25doc: update doc/sphinx/requirements.txtHeinrich Schuchardt1-2/+23
Pin all dependencies as reported by 'pip freeze'. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2022-01-15.readthedocs.yml: update the requirementsHeinrich Schuchardt1-3/+3
Fix an error: This project needs at least Sphinx v2.4.4. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2021-10-21doc: require Sphinx 3.4.3Heinrich Schuchardt1-1/+1
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 <xypron.glpk@gmx.de>
2021-08-14doc: require Sphinx 2.4.4Heinrich Schuchardt1-23/+3
Require Sphinx 2.44 to build the documentation. Remove all code related to earlier versions. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-04-04sphinx: Pin to docutils-0.16Tom Rini1-1/+1
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 <xypron.glpk@gmx.de> Signed-off-by: Tom Rini <trini@konsulko.com>
2021-01-27doc: update Kernel documentation build systemHeinrich Schuchardt12-12/+1029
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 <xypron.glpk@gmx.de>
2021-01-23Revert "doc: update Kernel documentation build system"Tom Rini12-1029/+12
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 <trini@konsulko.com>
2021-01-23doc: update Kernel documentation build systemHeinrich Schuchardt12-12/+1029
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 <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org> [Fix warning in b4860qds.rst about "Switch Settings"] Signed-off-by: Tom Rini <trini@konsulko.com>
2020-10-14doc: Sphinx.override_domain() deprecatedHeinrich Schuchardt1-1/+4
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 <xypron.glpk@gmx.de>
2020-04-27doc: sphinx: refresh parse-headers.pl from LinuxHeinrich Schuchardt1-2/+2
Copy parse-headers.pl from Linux kernel tree: * fix the parameter description %s/--man/--usage/ * fix a documentation reference Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-04-24doc: invalid doc link in rstFlatTable.pyHeinrich Schuchardt1-2/+0
Remove an invalid documentation link in rstFlatTable.py. This synchronizes the file with Linux next-20200413. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-02-24doc: update doc/sphinx/kerneldoc.pyHeinrich Schuchardt1-12/+39
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 <xypron.glpk@gmx.de>
2019-07-24doc: Cope with Sphinx logging deprecationsJonathan Corbet3-21/+59
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 <corbet@lwn.net> Rebased for U-Boot Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2019-06-20doc: Remove duplicated documentation directoryBreno Matheus Lima8-0/+1864
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 <breno.lima@nxp.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-22 12:18:49 +0000