Skip to content

Sanitise docs 2 - #427

Merged
James Bruten (james-bruten-mo) merged 6 commits into
MetOffice:github_wpsfrom
yaswant:sanitise-docs2
Sep 9, 2025
Merged

Sanitise docs 2#427
James Bruten (james-bruten-mo) merged 6 commits into
MetOffice:github_wpsfrom
yaswant:sanitise-docs2

Conversation

@yaswant

@yaswant Yaswant Pradhan (yaswant) commented Sep 7, 2025

Copy link
Copy Markdown
Contributor

Replace #423

Revisited various technical debts going through the entire documentation. No major changes to to contents.

Change summary

  • Update README.md with Simulation Systems repositories diagram (on GitHub); happy to move this to repo Wiki
  • Introduce pyproject.toml and uv to manage package dependencies
    • Note: I've updated .github/workflow/requirements.txt file, in case someone still wants to use conda (for this project I'd argue against it though). In principle, both env.yml and requirements.txt files can be safely deleted.
  • Introduce sphinx-lint to check restructured text (pyproject.toml)
  • Add some exceptions for link check (conf.py)
  • Replace pip with uv in GitHub Actions
  • Reformat almost all rst files
    • for consistent column width
    • fix some syntax errors
    • remove hidden Unicode characters (U+200B zero widh space) injected from someone's editor which made it impossible to compile latexpdf.

@yaswant Yaswant Pradhan (yaswant) added 🐛Bug Something isn't working 📘Documentation Improvements or additions to documentation 🪄Enhancement New feature or request labels Sep 8, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This looks good to me. It's big so something may have slipped through not formatted correctly, but I couldn't spot anything!

@james-bruten-mo
James Bruten (james-bruten-mo) merged commit 0e17071 into MetOffice:github_wps Sep 9, 2025
2 checks passed
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 🐛Bug Something isn't working 🪄Enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants