summaryrefslogtreecommitdiff
path: root/doc/conf.py
AgeCommit message (Collapse)AuthorFilesLines
2021-08-14doc: fix Latex marginsHeinrich Schuchardt1-12/+19
Adjust the Latex formatting to match Linux v5.13.1: * add Latex margins * reformat the code in doc/conf.py to match Linux Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-08-14doc: require Sphinx 2.4.4Heinrich Schuchardt1-75/+2
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-02-21doc: Add reference to U-Boot project in conf.pyHeinrich Schuchardt1-11/+13
With the last update of conf.py the references to U-Boot where replaced by references to Linux. Fix the project references in the generated documentation. Reported-by: Simon Glass <sjg@chromium.org> Reported-by: Bin Meng <bmeng.cn@gmail.com> Fixes: 98f01cf7a22e ("doc: update Kernel documentation build system") Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-27doc: update Kernel documentation build systemHeinrich Schuchardt1-28/+113
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 Rini1-113/+28
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 Schuchardt1-28/+113
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-12-15doc: allow building htmldoc with Sphinx 3+Heinrich Schuchardt1-1/+28
Due to removed function c_funcptr_sig_re building with Sphinx 3 fails. With the patch building succeeds with a lot of warnings if the '-W' flag is removed from doc/Makefile. Most of the documentation is correct This follows the approach taken by the Linux kernel. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-04-27doc: specify that xelatex is used as Latex engineHeinrich Schuchardt1-0/+2
Building the pdf documentation on readthedocs.org fails with pdflatex. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2020-04-24docs: Fix conf.py for Sphinx 2.0Jonathan Corbet1-1/+1
commit 3bc8088464712fdcb078eefb68837ccfcc413c88 upstream. Our version check in Documentation/conf.py never envisioned a world where Sphinx moved beyond 1.x. Now that the unthinkable has happened, fix our version check to handle higher version numbers correctly. Signed-off-by: Jonathan Corbet <corbet@lwn.net> [rebase for u-boot] Signed-off-by: Sean Anderson <seanga2@gmail.com>
2019-07-24doc: Add the U-Boot logo to the html docBin Meng1-1/+1
Now we have a logo for U-Boot, we can include it in the Sphinx html doc. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-06-20doc: Remove duplicated documentation directoryBreno Matheus Lima1-0/+528
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>