u-boot.git/doc/conf.py, branch v2026.07

binman: Add Sphinx extension to auto-generate entry and bintool docs

2026-04-17T05:12:07Z

Currently entries.rst and bintools.rst are generated manually by running 'binman entry-docs' and 'binman bintool-docs', then committed to the repo. This means the docs can drift out of date when docstrings are updated but the RST files are not regenerated. Add a Sphinx extension (binman_docs) that provides two custom directives: .. binman-entry-docs:: .. binman-bintool-docs:: These parse the etype and btool source files using the ast module to extract class docstrings, then insert the documentation directly into the document tree. This avoids the need to import binman modules (which have dependencies like libfdt that are not available in the ReadTheDocs build environment) and avoids writing any intermediate files. Signed-off-by: Simon Glass

doc: Use sys.path.append for pytests being found

2026-03-27T09:53:28Z

Rather than having our "docs" build tagets modify PTYHONPATH, have doc/conf.py append the required paths at runtime instead. This will ensure that our builds from readthedocs will also find all of the required files. Signed-off-by: Tom Rini

doc: pytest: Framework for documenting tests and document test_000_version

2025-05-11T10:52:56Z

In order to easily document pytests, we need to include the autodoc extension. We also need to make sure that for building the docs, CI includes pytest and that we have PYTHONPATH configured such that it will find all of the tests and related files. Finally, we need to have our comments in the test file by in proper pydoc format in order to be included in the output. Signed-off-by: Tom Rini Reviewed-by: Simon Glass

doc: Start improving our pytest documentation

2025-05-11T10:52:56Z

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 Reviewed-by: Simon Glass

doc: conf.py: correct title and author of generated pdf

2024-11-09T08:56:46Z

Adjust the PDF output options for rst2pdf: * Set start document to 'index'. * Set title to 'Das U-Boot'. * Set author to 'The U-Boot development community'. Correct documentation link. Remove obsolete FIXME. Link: https://rst2pdf.org/static/manual.html Signed-off-by: Heinrich Schuchardt

doc: define html_context in conf.py

2024-07-20T17:09:36Z

The dictionary html_context is not passed into conf.py but must be created there. See https://dev.readthedocs.io/en/latest/design/theme-context.html#customizing-the-context Fixes: df86796028df ("doc: enable ReadTheDocs addon management") Reviewed-by: Simon Glass Signed-off-by: Heinrich Schuchardt

doc: enable ReadTheDocs addon management

2024-07-19T11:46:29Z

Up to now ReadTheDocs has been injecting code when building on their platform. This includes for instance improvements for the search function. To maintain the current output ReadTheDocs requires setting html_baseurl and html_context in conf.py. See: https://about.readthedocs.com/blog/2024/07/addons-by-default/ Signed-off-by: Heinrich Schuchardt Reviewed-by: Tom Rini

doc: add sphinx_rtd_theme extension

2024-01-17T07:40:19Z

Newer versions of sphinx_rtd_theme require to add sphinx_rtd_theme to the list of extensions. Cf. https://github.com/readthedocs/readthedocs.org/pull/9654 Signed-off-by: Heinrich Schuchardt

doc: sphinx: Add sphinx-prompt

2023-08-27T06:21:08Z

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 Signed-off-by: Nishanth Menon Reviewed-by: Heinrich Schuchardt

doc: remove superfluous warning

2023-02-19T20:34:38Z

We have been using Sphinx >=3 since 2020. We don't expect issues. Signed-off-by: Heinrich Schuchardt