Re: Proposal: Abandoning monolithic Boost documentation.

From: Дмитрий Архипов (grisumbras_at_[hidden])
Date: 2025-04-22 19:50:20

вт, 22 апр. 2025 г. в 22:26, Robert Ramey via Boost <boost_at_[hidden]>:
>
> Each library will have its html files to document it.  Would it not be
> possible to write one (fancy) javascript to generate the the page above
> just by scanning all the released libraries html?
>
> Then we'd have everything we have now without any depencies outside any
> library. Looks practical to me.

The problem with storing generated HTML files in the project has
already been mentioned multiple times: people regularly forget to
update those HTML files when they change documentation. There's an
even worse problem when someone updates a HTML file, but not the
source file, and the changes are lost on the next regeneration.

And it doesn't solve the main problem with having multiple
documentation formats in the project: that a contributor will have a
hard time figuring out how to build docs for the library he is
interested in. This is because that contributor would still have to
get the necessary tool. With docs generated in CI, at least what are
those tools and how to get them is written somewhere (build scripts,
CI scripts, Dockerfiles).