search

ecmwf-ifs / loki

Freely programmable source-to-source translation for Fortran
https://sites.ecmwf.int/docs/loki/
Apache License 2.0
22 stars 11 forks source link

Docs: Update to links from static doc pages #312

Closed mlange05 closed 2 months ago

mlange05 commented 2 months ago

~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:

  1. Update static links in the documentation pages to sub-packages that have moved
  2. General update of docstrings that trigger silent errors or warnings in the docs build
  3. Addition of sub-package docstrings to give a brief overview of the respective sub-packages (the auto-generated API list looked empty to me).

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.

github-actions[bot] commented 2 months ago

Documentation for this branch can be viewed at https://sites.ecmwf.int/docs/loki/312/index.html

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 95.12%. Comparing base (cca7312) to head (055f580).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #312 +/- ## ======================================= Coverage 95.11% 95.12% ======================================= Files 165 165 Lines 35130 35143 +13 ======================================= + Hits 33415 33429 +14 + Misses 1715 1714 -1 ``` | [Flag](https://app.codecov.io/gh/ecmwf-ifs/loki/pull/312/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ecmwf-ifs) | Coverage Δ | | |---|---|---| | [lint_rules](https://app.codecov.io/gh/ecmwf-ifs/loki/pull/312/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ecmwf-ifs) | `95.08% <100.00%> (-1.31%)` | :arrow_down: | | [loki](https://app.codecov.io/gh/ecmwf-ifs/loki/pull/312/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ecmwf-ifs) | `95.07% <100.00%> (-0.03%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ecmwf-ifs#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mlange05 commented 2 months ago

Ok, thanks @reuterbal . Pushed fixes and rebased.