CI: add automated documentation builds #374
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I finally took the time to implement automated documentation builds. The actual generator lives in a separate repository and is downloaded here via a fully statically linked executable.
Documentation is currently built for all tags and the master branch. The build always uses the Doxyfile from master to ensure consistent documentation appearance. zydoc then generates an
index.html
containing links to all built documentation versions.The zydoc output is then pushed into the (private) doc.zydis.re repository which is automatically deployed to https://doc.zydis.re via Cloudflare Pages.
The index file is currently very plain, but @ChristianK43 has already agreed to build us a fancier one in the future(update: implemented!).I also intend to extend zydoc to inject a version selector displayed in the bottom right into each HTML file generated by Doxygen in order to simplify navigation between versions at a later point (e.g. see https://docs.djangoproject.com/en/4.0/ for a website with a similar approach).(update 2: also implemented!)Once this PR is approved and merged, I'll additionally set up redirects for the old documentation paths on
https://zydis.re/doc/
.