tudat-team / tudat-space

An introduction and guide to tudat-space.
https://tudat-space.readthedocs.io
14 stars 17 forks source link

Missing text for example applications #77

Closed transferorbit closed 1 year ago

transferorbit commented 1 year ago

In the documentation on this docs.tudat.space page, the example applications are devoid of any text; they’re currently showing only small images of plots (see image below). Some minimum level of text should be shown, such as a title and perhaps keywords.

Screenshot 2022-10-11 at 08 03 20
DominicDirkx commented 1 year ago

Thanks! This used to look different in the older version, I'll try to find out what we messed up

DominicDirkx commented 1 year ago

On my old system, this error does not show up (and everything renders properly). On my new system, the layout is messed up, as it is in the online build. I'll attach the conda environment contents here for future diagnostics old_conda.txt

DominicDirkx commented 1 year ago

new_conda.txt

DominicDirkx commented 1 year ago

old_conda.txt Build shows up properly new_conda.txt Build is messed up (as online)

sbcowan commented 1 year ago

The problem lies indeed with the sphinx-gallery package. In builds with sphinx-gallery=0.11.1 the gallery is formatted incorrectly, in sphinx-gallery=0.10.1 the gallery is correct. I presume this has to be changed in the conda packages for tudat-docs. Should I bissect where the cut-off point is or do we just stick with 0.10.1 for now?

DominicDirkx commented 1 year ago

Thanks for pinpointing this! I'll fix the version to 0.10.1 on readthedocs

DominicDirkx commented 1 year ago

So, good news and bad news :) I made the modifications to the environment.yaml file: https://github.com/tudat-team/tudat-space/blob/develop/docs/environment.yaml and when I create a new conda environment locally, it all works like a charm!

But, for some reason the readthedocs version is not yielding the correct result: https://readthedocs.org/projects/tudat-space/builds/19230543/ even though the conda page version seems to be correct, the resulting build is not, from the looks of it.

I'm not sure why, but will look into it again on Monday, if I have time. If you have any ideas, feel free to go ahead and tinker with them

DominicDirkx commented 1 year ago

Scratch the above, my browser was showing the cached version. Loading it anew shows it as it should! Nice!