Attention is currently required from: Nicholas Chin.
Hello build bot (Jenkins),
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/87231?usp=email
to look at the new patch set (#2).
Change subject: [POC] Docs/lib/timestamp.md: Use Breathe to generate API documentation ......................................................................
[POC] Docs/lib/timestamp.md: Use Breathe to generate API documentation
API documentation written on doc.coreboot.org is likely to go out of date when the code is changed, whereas docstrings directly in the code are more likely to be updated. As a proof of concept, use Breathe to pull the Doxygen function documentation for `include/timestamp.h` into our markdown documentation.
To view and build this, do one of the following:
1. Install the following python3 modules: - sphinx - myst-parser - sphinx_rtd_theme - breathe 2. Install Doxygen 3. Run `make` from the `Documentation` folder. The output will be in `Documentation/_build/html`
Change-Id: Iae85a33f11fe9dbe11943e63a4f1dfc95ccc0bf9 Signed-off-by: Nicholas Chin nic.c3.14@gmail.com --- M Documentation/lib/timestamp.md 1 file changed, 6 insertions(+), 16 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/31/87231/2