Skip to content

Conversation

@flicj191
Copy link
Contributor

@flicj191 flicj191 commented May 15, 2025

Description

For parallel updates to ESMValTool documentation:
ESMValGroup/ESMValTool#3914

Closes issue: ESMValGroup/ESMValTool#3860

Link to documentation:


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.


To help with the number pull requests:

@codecov
Copy link

codecov bot commented May 15, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.46%. Comparing base (84cfe15) to head (8b69fad).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2732   +/-   ##
=======================================
  Coverage   95.46%   95.46%           
=======================================
  Files         260      260           
  Lines       15519    15519           
=======================================
  Hits        14815    14815           
  Misses        704      704           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@flicj191 flicj191 marked this pull request as ready for review May 23, 2025 04:32
@flicj191 flicj191 requested review from ehogan and lukruh June 18, 2025 03:34
@flicj191 flicj191 added documentation Improvements or additions to documentation labels Jun 18, 2025
@flicj191
Copy link
Contributor Author

Currently just has ESMValCore for the .. toctree:: could still include the generation to list ESMValTool headings as well.
Quick schema diagram needs reviewing for consistency

@bouweandela bouweandela added this to the v2.14.0 milestone Oct 3, 2025
@bettina-gier
Copy link
Contributor

@lukruh, @ehogan Can you check if this PR is equivalent to the tool one and has all your comments incorporated so we can merge this simultaneously (and soon)?

Copy link
Contributor

@lukruh lukruh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs build fine. Landing page, header and sidebars are similar to the PR in the tool. The only difference I noticed were the icons in the header:

image

Both versions are fine (I personally prefer the simple icons as they are here), but would be nice to have them consistent.
@flicj191 if you are ok with me committing the other minor comments, I can do so and this can be merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants