Skip to content

CI: add automated documentation builds #374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2022
Merged

Conversation

athre0z
Copy link
Member

@athre0z athre0z commented Jul 31, 2022

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/.

@athre0z athre0z added C-enhancement Category: Enhancement of existing features A-doc Area: Documentation P-medium Priority: Medium labels Jul 31, 2022
@athre0z athre0z linked an issue Jul 31, 2022 that may be closed by this pull request
@athre0z athre0z marked this pull request as ready for review July 31, 2022 17:59
@athre0z athre0z requested a review from flobernd July 31, 2022 17:59
flobernd
flobernd previously approved these changes Aug 1, 2022
@athre0z athre0z force-pushed the automated-doc-builds branch from 6b93a79 to 9aeb2bf Compare August 1, 2022 20:52
@athre0z athre0z merged commit 9d6c82a into master Aug 1, 2022
@athre0z athre0z deleted the automated-doc-builds branch August 1, 2022 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-doc Area: Documentation C-enhancement Category: Enhancement of existing features P-medium Priority: Medium
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatic documentation builds using CI
2 participants