aboutsummaryrefslogtreecommitdiff
path: root/doc/Makefile
AgeCommit message (Collapse)AuthorFilesLines
2022-12-29doc: add texinfodocs and infodocs targetsMaxim Cournoyer1-0/+10
Sphinx supports generating Texinfo sources and Info documentation, which can be navigated easily and is convenient to search (via the indexed nodes or anchors, for example). This is basically the same as 1f050e904dd6f2955eecbd22031d912ccb2e7683, which was recently applied to the Linux kernel. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@savoirfairelinux.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2022-08-26doc: Build documentation in parallelSimon Glass1-0/+1
With the addition of the revision stats this now takes over a minute. Use a parallel build to reduce it a bit (24 seconds for me). Series-changes; 2 - Use '-j auto' instead Signed-off-by: Simon Glass <sjg@chromium.org>
2022-08-13binman: Add more documentation about binman usageSimon Glass1-0/+1
This is an attempt to answer the comments provided by Xavier [1]. [1] https://lore.kernel.org/all/Yulcol7HpTHtjXTX@begut/ Signed-off-by: Simon Glass <sjg@chromium.org> Acked-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2021-08-01doc: handle 'make htmldocs' warnings as errorsHeinrich Schuchardt1-1/+1
Parameter -W for sphinx-build turns build warnings into errors. This helps us to avoid bad patches passing Gitlab CI. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-03-02doc: describe the md commandSimon Glass1-1/+0
Provide a man-page for the md command. Signed-off-by: Simon Glass <sjg@chromium.org>
2021-01-23doc: update help messagePatrick Delaunay1-1/+1
Update the help message used for 'make help': Documentation targets: Linux kernel internal documentation in different formats from ReST: => U-Boot documentation in different formats from ReST: Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2020-02-25doc/Makefile: turn warnings into errorsHeinrich Schuchardt1-0/+1
Several patches delivered incorrect restructured text as documentation. We should be able to discover this in Travis CI, Gitlab CI, or Azure CI. So let us turn all build warnings into errors. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2019-06-20doc: Remove duplicated documentation directoryBreno Matheus Lima1-0/+124
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>