CI: clean up documentation and generate it with GitHub Actions #137
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.
Background
I've been looking through the documentation a bit on Genesis and found that here are multiple copies of the documentation included in the repository:
/MANUAL.md
and/MANUAL*
at the top-level/manual/MANUAL.md
and others under/manual
/manual/Genesis-Manual.pdf
) and its source LaTeX file/manual/Manual.pdf
which is generated with pandoc using/manual/*.md
Changes
Assuming my understanding is correct, I've taken the steps in this PR to:
GitHub Actions
Note - you will have to enable a setting in the repository to allow for the deployment process to work correctly. It's as simple as going to the repository settings and selecting "GitHub Actions" as the source.
![Screenshot 2024-01-05 at 11 52 41 AM](https://private-user-images.githubusercontent.com/152229072/294596646-f013663d-b3ce-44cc-b91b-242959deafa4.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ3OTc2NDcsIm5iZiI6MTcyNDc5NzM0NywicGF0aCI6Ii8xNTIyMjkwNzIvMjk0NTk2NjQ2LWYwMTM2NjNkLWIzY2UtNDRjYy1iOTFiLTI0Mjk1OWRlYWZhNC5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjQwODI3JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI0MDgyN1QyMjIyMjdaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04ZWUzZTlhZTFkMTI2ZTA1NTkzODRhMzc3Nzc2OWIzMmQ1Y2FjMDIyNWFmMjYyMjZhY2U3MGZhOGViZjk5OGU5JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZhY3Rvcl9pZD0wJmtleV9pZD0wJnJlcG9faWQ9MCJ9.i6FOAKvWeOAlg8sC9o5n10TvP-dO6iIpEZSfS_Cwrf0)
Testing / sample
I ran the included GitHub Actions on my own fork and here are the results:
Future
We could make a nicer webpage for Genesis, if you'd like. Something along the lines of what we have for https://slaclab.github.io/lume-genesis/ for example.