Created a quick get started tutorial using sphinx and GitHub actions … #30
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
…27) * Implemented tutorial format * Fixed wrong .yml path * Wrong build command fixed * Ample installation instructions * Added section on HPC running * Added installation instructions * Grammar * Correct path * Fixed headers and made a succesful admonition * Grammar * Itemisation doesn't need spaces between them * Access documentation * Some grammar * More installation instructions and project setup * Wrote scenario setup * Explained the scenario structure logic * Added addons page * Started running Balmorel page * Fixed links * Made a working test_run scenario * Finished running Balmorel section * There's now a minimal get started / 'hello world' guide for installing and running Balmorel, related to issue #25 * Corrected version and added general description * Added output analysis video * Added PuTTY login example * Made explanation for accessing WinSCP * Minimal guide to submitting jobs to the HPC finalised, related to issue #25 * Wrong wording * Added some notes on how to check the log * A link to the full documentation is made, which resolves #25 * Made copy button for code snippets * Trying to generate code snippets copy button again * Removed packages that did not exist, and trying with conda install copy button * Fixed copy button not appearing - needed to add is as extension in conf.py * Transferred the github action to master * Fixed some grammar error and added CLI description
|
Hi Theis, this will just add the markdown files (.md) for our new documentation at https://balmorelcommunity.github.io/Balmorel into your branch :) (As you can see, only added files). You could merge this after an approval of the pull request #31, which includes some documentation on which branches exist and some more info in the Balmorel/base/documentation/gh-pages/README.md on how to write and test this documentation locally :) |
* Added documentation on branches * Updated the requirements in the readme for creating documentation * Made oneliner explanations in overview section * Made a link for the documentation in the README
|
Pulled new documentation from master |
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.
…(#27)
Implemented tutorial format
Fixed wrong .yml path
Wrong build command fixed
Ample installation instructions
Added section on HPC running
Added installation instructions
Grammar
Correct path
Fixed headers and made a succesful admonition
Grammar
Itemisation doesn't need spaces between them
Access documentation
Some grammar
More installation instructions and project setup
Wrote scenario setup
Explained the scenario structure logic
Added addons page
Started running Balmorel page
Fixed links
Made a working test_run scenario
Finished running Balmorel section
There's now a minimal get started / 'hello world' guide for installing and running Balmorel, related to issue We should have a minimal get started guide for Balmorel on github pages #25
Corrected version and added general description
Added output analysis video
Added PuTTY login example
Made explanation for accessing WinSCP
Minimal guide to submitting jobs to the HPC finalised, related to issue We should have a minimal get started guide for Balmorel on github pages #25
Wrong wording
Added some notes on how to check the log
A link to the full documentation is made, which resolves We should have a minimal get started guide for Balmorel on github pages #25
Made copy button for code snippets
Trying to generate code snippets copy button again
Removed packages that did not exist, and trying with conda install copy button
Fixed copy button not appearing - needed to add is as extension in conf.py
Transferred the github action to master
Fixed some grammar error and added CLI description