[DOCS] Cleaning up the documentation - #2825
Conversation
Fixing linking errors, myST warnings, and removing TODOs
|
Should we update our settings on the Sphinx docs build to fail on these types of warnings? |
|
Good question, I'm not sure how robust this pipeline would be. But we could certainly try for a while. if it triggers too many (erroneous) failed builds, we can always revert Could you turn failing on warnings on? |
VeckoTheGecko
left a comment
VeckoTheGecko
left a comment
There was a problem hiding this comment.
just a couple comments/clarifications
| particles.temperature = fieldset.temperature[ | ||
| particles.t, | ||
| particles.z, | ||
| particles.y, | ||
| particles.x, | ||
| particles | ||
| ] |
There was a problem hiding this comment.
Curious if this is a result of an autoformatter? (if not, I think it would be a good ideal to include an autoformatter for python code cells in docs)
There was a problem hiding this comment.
No, I hand-formatted this for better readability. An autoformatter would indeed be a good idea
There was a problem hiding this comment.
Cool, I'll see if I can include that in this/a separate PR
Just about to head off, can look into next week |
This reverts commit c781dd0.
Basing them off the ones in Xarray https://github.com/pydata/xarray/blob/af3dad69b7ee7b95fb4510e40bcd25405cdc64a5/doc/Makefile#L5 . e.g., failing on warning
|
Just added c3a011d which enables failures on warnings and also configures Sphinx to use multiple processors where it can |
|
feel free to merge - I can look at the formatting in a separate PR |
|
2 participants
Description
This PR cleans up the Documentation, by fixing linking errors and myST warnings, and removing TODOS
Checklist
mainfor normal development,v3-supportfor v3 support)AI Disclosure
I have asked CoPilot to help me remove the
WARNING: skipping unknown output mime type: application/vnd.holoviews_load.v0+json [mystnb.unknown_mime_type] [mystnb.unknown_mime_type]warnings - and the warnings about missing cross-reference targets in notebook links