[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
| ```{code-cell} | ||
| ```{code-block} python | ||
| ds = ds.load() | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Curious as to why these are code-blocks and note code-cells? This doesn't match the documentation of Myst-parser which we're using (docs)
There was a problem hiding this comment.
This is intentional. These are now code-blocks because these shouldn't be run by the parser. The data is not available and the notebook doesn't even have import statements; so running these will fail
| 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
Just about to head off, can look into next week |
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