search

Linaro / OpenCSD

CoreSight trace stream decoder developed openly
https://github.com/Linaro/opencsd/wiki
Other
141 stars 53 forks source link

decoder/docs/html not published #34

Closed ggardet closed 3 years ago

ggardet commented 3 years ago

decoder/docs/html/* is not generated and not part of the git repo. It would be great to add html docs to avoid every distro to regenerate it.

mikel-armbb commented 3 years ago

Hi,

The html docs can be generated in < 10 s on my machine.

Generating this and adding to github to publish would add 40MB of html files and binary artefacts to the repo - and cause hugh churn as each .html file has an embedded "generated on " embedded. Some artefact files have auto-generated file names.

Therefore it is not desirable or practical to publish the generated .html in the repo.

Those distros that do want the include the .html docs can do so with very little effort in generating the documentation at the same time as they build the library.

Thanks

Mike