Have CI build docs in lieu of current update-docs.sh script about omniperf HOT 4 CLOSED

I prefer the markdown source to be part of the repo. It allows you to update/modify the docs alongside changes in the source (same PR) and can also help while searching for things in repo

from omniperf.

But I agree, there should be a GitHub action that updates the docs when a release occurs. I haven't gotten around to it in omnitrace but if y'all figure it out, lmk so I can steal it.

from omniperf.

Also, turn warnings as errors on (if possible) for things like #33

from omniperf.

This is now live with the introduction of a new github action: docs.yml

In the current configuration, the authoritative markdown inputs live in src/docs on the main branch. When documentation-related changes occur on the main branch, a CI job will build the latest docs using a sphinx container. These are then deployed to GitHub pages using the deploy-pages action.

Note that with this approach, static html files no longer need to reside in the repository.

from omniperf.