search

MESMER-group / mesmer

spatially-resolved ESM-specific multi-scenario initial-condition ensemble emulator
https://mesmer-emulator.readthedocs.io/en/latest/
GNU General Public License v3.0
23 stars 17 forks source link

docs: clean landing page #450

Closed mathause closed 4 months ago

mathause commented 4 months ago

Currently our landing page looks a bit strange - some parts of the index is hidden, some part is not, and there are two titles (one above and one below the index) see https://mesmer-emulator.readthedocs.io/en/v0.10.0/.

This PR hides the whole index, relegating it entirely to the side bar. Then it only shows the readme text, which makes much more sense. (Moving .. include:: ../../README.rst up is just a formality).

codecov[bot] commented 4 months ago

Codecov Report

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

Project coverage is 83.65%. Comparing base (9b0b76b) to head (b4874a3). Report is 81 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #450 +/- ## ========================================== - Coverage 87.90% 83.65% -4.26% ========================================== Files 40 44 +4 Lines 1745 1939 +194 ========================================== + Hits 1534 1622 +88 - Misses 211 317 +106 ``` | [Flag](https://app.codecov.io/gh/MESMER-group/mesmer/pull/450/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/MESMER-group/mesmer/pull/450/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=MESMER-group) | `83.65% <ø> (-4.26%)` | :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=MESMER-group#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.

veni-vidi-vici-dormivi commented 4 months ago

Can I look at the new landing page without having to pull this?

mathause commented 4 months ago

Can I look at the new landing page without having to pull this?

Yes, under the checks -> docs/readthedocs.org:mesmer-emulator -> Details. It shows the build process and the docs once the that's finished.

mathause commented 4 months ago

Thanks