aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx
AgeCommit message (Collapse)Author
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 <xypron.glpk@gmx.de> Signed-off-by: Tom Rini <trini@konsulko.com>
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 <xypron.glpk@gmx.de>
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 <trini@konsulko.com>
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 <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 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 <xypron.glpk@gmx.de>
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 <xypron.glpk@gmx.de>
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 <xypron.glpk@gmx.de>
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 <xypron.glpk@gmx.de>
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 <corbet@lwn.net> Rebased for U-Boot Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
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 <breno.lima@nxp.com>