bst example html in the doc's is out of date and is hard to maintain
Summary
Maintaining the .run files and there output is harder than it needs to be and the cached versions are not being updated.
Steps to reproduce
Example output like this
https://buildstream.gitlab.io/buildstream/examples/flatpak-autotools.html#build-the-hello-bst-element
is not only out of date intrms of reporting version numbers much older than the docs but the general output has changed some what, for instance it should read Loading elements rather than Loading pipeline
and examples like https://buildstream.gitlab.io/buildstream/developing/workspaces.html#opening-a-workspace that have had there .run files updated for the new command line are not updated.
What is the current bug behavior?
There are two related issues, the current behaviour of make -C doc dose not update the bst2html output if a html file exists, this means that you must force all the .run files to be built to update a single one. this means people avoid updates. Because we do not run bst2html in CI and we are not keeping the cache upto date the docs are now out of date.
What is the expected correct behavior?
The Doc's should reflect current bst behaviour.
It should be easy to update .run files.
Relevant logs and/or screenshots
https://buildstream.gitlab.io/buildstream/developing/workspaces.html#opening-a-workspace https://buildstream.gitlab.io/buildstream/examples/flatpak-autotools.html#build-the-hello-bst-element but any example run in https://buildstream.gitlab.io/buildstream/
Possible fixes
I propose to run bst2html when the CI makes the doc's and to make bst2hmlt cacheing less aggressive.
The CI already runs bst2html but the .run files are not present, i propose to have the .run files present and remove the cached copies from the repo.
Other relevant information
- BuildStream version affected: website / master/all