search

MHKiT-Software / MHKiT

MHKiT Documentation
https://MHKiT-Software.github.io/MHKiT/
4 stars 14 forks source link

Images Not showing Up in Examples #30

Closed ssolson closed 4 years ago

ssolson commented 4 years ago

@rpauly18 pointed this out this morning and I have confirmed

kmruehl commented 4 years ago

@rpauly18 @ssolson looking into it now. This appears to be an issue only with the python examples, across the board, but not the matlab examples.

kmruehl commented 4 years ago

The issue is the location of the images generated by Jupyter notebook examples. They are actually being saved here: https://github.com/MHKiT-Software/MHKiT/tree/master/docs/doctrees/nbsphinx, but the documentation is looking for them here: https://github.com/MHKiT-Software/MHKiT/tree/master/docs/_images. I looked into how to properly configure the Jupyter notebook image directory, but was unable to find a resolution, so for now I manually copied the files into the proper directory. It seems like the core of this issue is the dependency on nbsphinx-link. I'll continue to look into this issue.

kmruehl commented 4 years ago

I have removed the dependency on nbsphinx_link, and we are using nbsphinx to compile the jupyter notebook examples. This means that the jupyter notebook examples must be on the same directory level as conf.py. Right now this means manually copying the jupyter notebook examples files into the appropriate directory, instead of using the files from the submodule.

kmruehl commented 4 years ago

This issue should be fully resolved with https://github.com/MHKiT-Software/MHKiT/commit/e2a272f74416e7a7ebb6e320acc604decd760a46, where I automated the copy/paste of python and matlab example files into the appropriate directory with make.bat.