CI: clean up documentation and generate it with GitHub Actions #137
Conversation
This file contains 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
|
Here's an example for how Bmad.jl lattices are looking at the moment: |
|
The docs are now published here: |
|
@svenreiche What do you think about us automatically making an mkdocs site like https://slaclab.github.io/lume-genesis/ (mentioned above)? |
|
Hi Christopher,
for sure this would be a great option to have a dedicated website.
However I am getting busy these days and don't know when I have enough time to inform myself on how to do that.
Also thank you for the workflow to generate the manual. This also completely new for me.
Best
Sven
…-----------------------------------
Paul Scherrer Institut
Sven Reiche
WBGB/119
CH-5232 Villigen PSI
Telefon: +41 56 310 51 19
E-Mail: ***@***.******@***.***>***@***.***>***@***.***>
________________________________
From: Christopher Mayes ***@***.***>
Sent: Tuesday, January 9, 2024 01:27
To: svenreiche/Genesis-1.3-Version4 ***@***.***>
Cc: Reiche Sven ***@***.***>; Mention ***@***.***>
Subject: Re: [svenreiche/Genesis-1.3-Version4] CI: clean up documentation and generate it with GitHub Actions (PR #137)
@svenreiche<https://github.com/svenreiche> What do you think about us automatically making an mkdocs site like https://slaclab.github.io/lume-genesis/ (mentioned above)?
—
Reply to this email directly, view it on GitHub<#137 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AK2LSE3FNWQKWFLZ5JNZNJ3YNSFI3AVCNFSM6AAAAABBO4RHXGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOBSGA2DQNJTHE>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.mdand/MANUAL*at the top-level/manual/MANUAL.mdand others under/manual/manual/Genesis-Manual.pdf) and its source LaTeX file/manual/Manual.pdfwhich is generated with pandoc using/manual/*.mdChanges
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.
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.