Skip to content

ReadTheDocs: updates to fix render#2727

Merged
Lestropie merged 1 commit intomasterfrom
fix_readthedocs_render
Oct 5, 2023
Merged

ReadTheDocs: updates to fix render#2727
Lestropie merged 1 commit intomasterfrom
fix_readthedocs_render

Conversation

@jdtournier
Copy link
Copy Markdown
Member

@jdtournier jdtournier commented Oct 4, 2023

Resorted to re-generating a default Sphinx config, and adding back the bits we specifically needed. Seems to fix the render issues we were having. I'm not sure what caused the problem exactly, but the config files are now considerably simpler, which is no bad thing...

See rendered version of this branch on ReadThedocs:
https://mrtrix.readthedocs.io/en/fix_readthedocs_render/

@jdtournier jdtournier requested review from a team and Lestropie October 4, 2023 16:38
@jdtournier jdtournier self-assigned this Oct 4, 2023
Copy link
Copy Markdown
Member

@Lestropie Lestropie left a comment

Choose a reason for hiding this comment

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

Looks to be rendering correctly.

What's not evaluated here is compilation of non-HTML versions of the documentation. We'd previously discussed bundling these with pre-compiled binary downloads. But not sure that this capability is currently in use anywhere. Would rather fix the online docs now, and if there's issues elsewhere that can be raised standalone.

@Lestropie Lestropie added this pull request to the merge queue Oct 5, 2023
Merged via the queue into master with commit e757e07 Oct 5, 2023
@Lestropie Lestropie deleted the fix_readthedocs_render branch October 5, 2023 01:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants