Open
Conversation
Member
Author
|
The current v2.2.0 manual was produced with an earlier version of this script and I checked that the 2.1.0 import is identical. 2.0.1 has a small diff for heading links, but I think we introduced those manually. |
Read manual.md from _repos/sel4/microkit and transform into docsite version. Also copy over diagram, adjust symlink, and build PDF. Very ad hoc and full of assumptions about manual.md, but better than doing these steps manually each time. Also has an option to create a dev version of the manual, but so far unused. Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
The other versions use a `v` prefix. Add here as well. Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add a python script that automatically transforms
manual.mdfrom_repos/sel4/microkitinto the corresponding docsite version (removing LaTeX, switching to svg, adding docsite front matter). Also copy over diagram, adjust symlink, and build PDF.Very ad hoc and full of assumptions about
manual.md, but better than doing these steps manually each time.Also has an option to create a dev version of the manual, but so far unused.
In a future PR, we could add that to the Makefile for the default build so that it updates automatically. Mostly need to think about where to link it from. Maybe then is also the time for a drop-down somewhere that chooses the version of the manual to view.