Skip to content

Sanitise docs - #423

Closed
Yaswant Pradhan (yaswant) wants to merge 9 commits into
MetOffice:mainfrom
yaswant:sanitise-docs
Closed

Sanitise docs#423
Yaswant Pradhan (yaswant) wants to merge 9 commits into
MetOffice:mainfrom
yaswant:sanitise-docs

Conversation

@yaswant

@yaswant Yaswant Pradhan (yaswant) commented Aug 30, 2025

Copy link
Copy Markdown
Contributor

** DONT MERGE **

This PR is replaced by #427

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 Aug 30, 2025
@yaswant
Yaswant Pradhan (yaswant) marked this pull request as draft September 7, 2025 23:59
@yaswant Yaswant Pradhan (yaswant) added the ⛔WontFix This will not be worked on label Sep 8, 2025
@yaswant

Copy link
Copy Markdown
Contributor Author

superseded by #427

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 ⛔WontFix This will not be worked on

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant