Skip to content
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

Automating Reference Documentation publication #37

Open
NikolajBjorner opened this issue Jul 7, 2022 · 4 comments
Open

Automating Reference Documentation publication #37

NikolajBjorner opened this issue Jul 7, 2022 · 4 comments

Comments

@NikolajBjorner
Copy link
Collaborator

Currently the reference documentation is built on releases and available as a zip file from the release hive.

https://github.com/Z3Prover/z3/releases/download/z3-4.9.1/z3doc.zip

Then I manually download this and unzip the contents into z3prover.github.io/api/html
It is a repository under https://github.com/z3prover
Commit and push

The process for uploading artifacts should be reasonably similar for releases.
Even a self-contained GitHub action that builds documentation by itself and pushes to the right place (could be microsoft.github.io/z3guide if this is better) would be great and perhaps easier to maintain than complicating the release.yml Azure pipeline.

@NikolajBjorner
Copy link
Collaborator Author

Parameters.md are now generated as part of documentation build.
From there they are currently manually copied to z3prover.github.io and to github.com/z3prover/z3 landing directory.

@pelikhan
Copy link
Member

pelikhan commented Sep 1, 2022

@NikolajBjorner can you walk me through this process? maybe i can help automating this

@NikolajBjorner
Copy link
Collaborator Author

Can it be copied from z3doc.zip asset from

@NikolajBjorner
Copy link
Collaborator Author

I other words create an action that triggers on relaese to copy over parameters.md, and optionally update z3prover.github.io

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants