[PATCH 0/2] Auto-generate binman entry and bintool documentation

[Simon Glass]

Hi Heinrich,

On Fri, 17 Apr 2026 at 17:37, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>
> On 3/18/26 14:23, Simon Glass wrote:
> > The entries.rst and bintools.rst files are currently generated manually
> > by running 'binman entry-docs' and 'binman bintool-docs', then committed
> > to the repo. This means the docs drift out of date when docstrings are
> > updated but the RST files are not regenerated.
> >
> > This series provides a Sphinx extension to generate the file. This
> > approach keeps the docs in sync with the source. It also avoids
> > importing binman modules so as to remain compatible with readthedocs.io
> >
> >
> > Simon Glass (2):
> >    binman: Add Sphinx extension to auto-generate entry and bintool docs
> >    binman: Remove pre-generated entries.rst and bintools.rst
> >
> >   doc/.gitignore                   |    2 +
> >   doc/conf.py                      |    3 +-
> >   doc/develop/package/bintools.rst |    1 -
> >   doc/develop/package/entries.rst  |    1 -
> >   doc/sphinx/binman_docs.py        |  207 ++
> >   tools/binman/binman.rst          |   12 +-
> >   tools/binman/bintools.rst        |  249 ---
> >   tools/binman/entries.rst         | 3129 ------------------------------
> >   8 files changed, 215 insertions(+), 3389 deletions(-)
> >   delete mode 120000 doc/develop/package/bintools.rst
> >   delete mode 120000 doc/develop/package/entries.rst
> >   create mode 100644 doc/sphinx/binman_docs.py
> >   delete mode 100644 tools/binman/bintools.rst
> >   delete mode 100644 tools/binman/entries.rst
> >
>
> Hello Simon,
>
> When applying the series I saw that generated documentation is missing for:
>
> Bintool: p11_kit: p11-kit – support tool for pkcs#11 libraries
> Bintool: pkcs11_tool: pkcs11-tool – support tool for managing pkcs#11 tokens
> Bintool: softhsm2_util: SoftHSMv2 – support tool for libsofthsm2
>
> It would be great if in a future patch you could add the missing
> docstrings for these.

OK I sent a small series for this.

Regards,
Simon