Feature: Adding user guide documentation #97
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
FlorianDeconinck
requested changes
Jan 14, 2025
| # built documents. | ||
| # | ||
| # The short X.Y version. | ||
| version = u"0.1" |
There was a problem hiding this comment.
Update to current
| # The short X.Y version. | ||
| version = u"0.1" | ||
| # The full version, including alpha/beta/rc tags. | ||
| release = u"0.1" |
| Gt4py | ||
| ========== | ||
|
|
||
| pace-physics includes the Python implementation of GFS physics built using the GT4Py domain-specific language. |
There was a problem hiding this comment.
pySHiELD not pace-physics
| @@ -0,0 +1,7 @@ | |||
| Gt4py | |||
There was a problem hiding this comment.
Point to the gt4py docs: https://gridtools.github.io/gt4py/latest/index.html
|
|
||
| overview | ||
| users_guide | ||
| program_guide |
There was a problem hiding this comment.
The users guide is not a users guide it's a developer guide or a technical guide. Please move the content of it into a "NDSL developer technical documentation" and "Users guide" should be a user forward, no technical detail, but how to code with NDSL.
While you are at it introduce a "porting from Fortran" section
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.
Description
This PR includes documentation as created by @xyuan. Upon approval a
Read The Docswill be created for these documents.How Has This Been Tested?
Does not affect functional code
Checklist: