Further formatting fixes to the PC2 and boundary-layer scheme docs ported from the UMDPs.#523
Open
MichaelWhitall wants to merge 113 commits into
Open
Further formatting fixes to the PC2 and boundary-layer scheme docs ported from the UMDPs.#523MichaelWhitall wants to merge 113 commits into
MichaelWhitall wants to merge 113 commits into
Conversation
…CloudScheme.tex to convert the latex source to .rst format.
… extension! Updated syntax to use this for the first few equations.
…hon script written by copilot.
…eferecing, and re-applied the corrections using an automatic script (most things stay the same, but my tweaks to reduce line-lengths have been reveretd).
…s possible to label and reference the individual equations in sphynx.
…'t converted to .rst correctly) with correctly-formatted display-mode equations.
…erical application', (b) Corrected a stray wrong indent, (c) Remove colon from appendix section titles (messes-up when used in the label).
…pply automated changes from scratch. Needed to apply corrections to section references in tables.
…and get the literature citations to work...
…tomating the corrections to figures and figure cross-referencing (then re-applied the manual fixes from 8 April 2026 using git apply).
…d figure captions.
…ng lines at double-spaces.
…igure caption, and remaining instances of latex math \rm (meant to replace with \mathrm).
…) Restored aligned math regions where the contained equations are meant to be labeled as a group, (b) Deleted spurious trailing whitespace, (c) Changed format of UMDP cross-reference placeholders to avoid lint warnings.
…gions, removed stray curly brackets in bibtex entries.
…math inside emphasis regions, reinstate closing brackets after equation references).
…oved this from manual corrections.
…e this in manual corrections where appropriate.
…h the same equation label used in the BL doc.
… from the CONTRIBUTORS.md file, causing the check-cla task to fail, but just reinstated in last commit to main).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Sci/Tech Reviewer: Paul Barrett (@paul-barrett)
Code Reviewer: Yaswant Pradhan (@yaswant)
#450 and #465 made an initial port of the UM Documentation Papers describing the PC2 cloud-scheme and the Boundary-Layer scheme into the lfric_apps science guide. This involved fixing many formatting errors when converting the source from latex to Sphinx / ReStructureText. Subsequent to those PRs being lodged, further formatting problems have been found. This PR attempts to fix these problems:
**) or bold (****); to get these equations to display I needed to close the enclosing**or*before the math, then open it again afterwards. Where math was inside a bold (****) region, I've used latex \boldsymbol to make it render bold as intended.\\"u(for a u with double-dots above) fooled my script as the"was interpreted as the end of the field string, so author names containing this character were spuriously truncated.Copy of the built docs: science_guide/index.html#science-guide-index
Code Quality Checklist
****Only documentation is edited; the doc source should speak for itself without needing explanatory comments, but feel free to suggest if you'd like any clarifying comments in the source?**check_cr_approved won't pass until code review is approved.Testing
*****Only modified documentation; rose-stem not applicable.To test the changes, I have built the lfric_apps docs from the branch source. The build now gives no errors or warnings.
trac.log
Security Considerations
**I'm not aware of any security issues with the docs. Does anyone know if there are license implications though? The latex UMDPs that I'm porting from are private, whereas the lfric_apps docs that I'm porting to are open-access?Performance Impact
NA
AI Assistance and Attribution
I got M365 copilot to help update the python scripts which I'm using to automate the format corrections applied to the doc ReST source after running pandoc (and the scripts were largely written by copilot in the first place).
Documentation
This is a documentation-only PR
PSyclone Approval
NA
Sci/Tech Review
(Please alert the code reviewer via a tag when you have approved the SR)
Code Review