[PATCH 16/20] binman: doc: Add documentation to htmldocs

[Simon Glass]

Hi Heinrich,

On Sun, 7 Mar 2021 at 15:02, Heinrich Schuchardt <xypron.glpk at gmx.de> wrote:
>
> On 3/7/21 8:31 PM, Simon Glass wrote:
> > Add a link to binman's documentation and adjust the files so that it is
> > accessible. Use the name README.rst so it is easy to discover when binman
> > is installed without U-Boot.
> >
> > Signed-off-by: Simon Glass <sjg at chromium.org>
> > ---
> >
> >   doc/index.rst                       |   1 +
> >   doc/package/binman                  |   1 +
> >   doc/package/fit.rst                 |   8 +
>
> This information is only of interest for developers, not for end-users.
> Please, place that information in /doc/develop/.

What is the difference between this and building? The build stuff is
at the top level. People presumably need to package U-Boot as well, in
order to use it.

>
> >   doc/package/index.rst               |  20 ++
> >   tools/binman/{README => README.rst} | 480 ++++++++++++++--------------
>
> tools/binman/ is the wrong path for documentation. Please, put the file
> in /doc/develop/binman.rst or /doc/develop/tools/binman.rst so that it
> becomes available online.

Does this mean that README.rst would not appear? Why not?

See the commit message for why I chose this. I suppose I could add a
separate README if needed.

Regards,
Simon