Docs: Update to links from static doc pages #312
Merged
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
|
Documentation for this branch can be viewed at https://sites.ecmwf.int/docs/loki/312/index.html |
mlange05
force-pushed
the
naml-docs-update
branch
2 times, most recently
from
44d9634
to
e022c98
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #312 +/- ##
=======================================
Coverage 95.11% 95.12%
=======================================
Files 165 165
Lines 35130 35143 +13
=======================================
+ Hits 33415 33429 +14
+ Misses 1715 1714 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
mlange05
force-pushed
the
naml-docs-update
branch
13 times, most recently
from
b1e2708
to
7958714
Compare
reuterbal
force-pushed
the
naml-docs-update
branch
from
7958714
to
621ad6c
Compare
reuterbal
requested changes
May 10, 2024
loki/build/__init__.py
Outdated
| Just-in-Time compilation utilities used in the Loki test base. | ||
|
|
||
| These allow compilation and wrapping of generated Fortran source code | ||
| using `f90wrap <https://github.com/jameskermode/f90wrap>` for |
There was a problem hiding this comment.
Suggested change
| using `f90wrap <https://github.com/jameskermode/f90wrap>` for | |
| using `f90wrap <https://github.com/jameskermode/f90wrap>`_ for |
loki/expression/__init__.py
Outdated
Comment on lines
8
to
9
| Expression layer of the two-level Loki IR based on `Pymbolic | ||
| <https://github.com/inducer/pymbolic`. |
There was a problem hiding this comment.
Suggested change
| Expression layer of the two-level Loki IR based on `Pymbolic | |
| <https://github.com/inducer/pymbolic`. | |
| Expression layer of the two-level Loki IR based on | |
| `Pymbolic <https://github.com/inducer/pymbolic>`_. |
loki/frontend/__init__.py
Outdated
| Frontend parsers that create Loki IR from input Fortran code. | ||
|
|
||
| This includes code sanitisation utilities and several frontend parser | ||
| interfaces, including the REGEX-frontend that used for fast source |
There was a problem hiding this comment.
Suggested change
| interfaces, including the REGEX-frontend that used for fast source | |
| interfaces, including the REGEX-frontend that is used for fast source |
loki/frontend/__init__.py
Outdated
|
|
||
| This includes code sanitisation utilities and several frontend parser | ||
| interfaces, including the REGEX-frontend that used for fast source | ||
| code exploration in large call trees. |
There was a problem hiding this comment.
Suggested change
| code exploration in large call trees. | |
| code exploration in large call and dependency trees. |
loki/transformations/__init__.py
Outdated
| """ | ||
| Sub-package with supported source code transformation passes. | ||
|
|
||
| This sub-package includes general source code trnasformations and |
There was a problem hiding this comment.
Suggested change
| This sub-package includes general source code trnasformations and | |
| This sub-package includes general source code transformations and |
loki/batch/__init__.py
Outdated
|
|
||
| This sub-package provides the :any:`Scheduler` class that allows Loki | ||
| transformations to be applied over large source trees. For this it | ||
| provides the basic :any:`Transformation` and :and:`Pipeline` classes |
There was a problem hiding this comment.
Suggested change
| provides the basic :any:`Transformation` and :and:`Pipeline` classes | |
| provides the basic :any:`Transformation` and :any:`Pipeline` classes |
mlange05
force-pushed
the
naml-docs-update
branch
from
621ad6c
to
055f580
Compare
|
Ok, thanks @reuterbal . Pushed fixes and rebased. |
reuterbal
approved these changes
May 12, 2024
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.
Filing early to get the resulting change and errors logs. Please ignore for now...General documentation update following the move of sub-packages. This primarily does three things:
Unfortunately, I didn't get everything in the docstring clean-up commit, and there are still a few warnings I do not understand. The overall impact should be net-positive though.