search

NCAR / CUPiD

CUPiD is a “one stop shop” that enables and integrates timeseries file generation, data standardization, diagnostics, and metrics from all CESM components.
https://ncar.github.io/CUPiD/
Apache License 2.0
25 stars 24 forks source link

Images for config file were showing up during testing but are not showing up in documentation #133

Closed TeaganKing closed 2 months ago

TeaganKing commented 2 months ago

Upon merging #128 , the images of the configuration file showed up locally during testing but did not show up on our documentation page when the PR was actually merged.

mnlevy1981 commented 2 months ago

It looks like the image link in the markdown and html is

<img src="[../../../images/config_1.png](view-source:https://ncar.github.io/images/config_1.png)" alt="CUPiD Config 1" width=1000 />

But https://ncar.github.io/CUPiD/config.html isn't three levels deep. I think what we need to do is have conf.py copy all the images into docs/image (and hope that Sphinx then copies them into docs/_build/html/images), and then use

<img src="[images/config_1.png](view-source:https://ncar.github.io/images/config_1.png)" alt="CUPiD Config 1" width=1000 />
mnlevy1981 commented 2 months ago

Actually, it looks like _static/images is already copied over... so have conf.py copy ${CUPID}/images/* into ${CUPID}/docs/_static/images/ and then use


```html
<img src="[_static/images/config_1.png](view-source:https://ncar.github.io/images/config_1.png)" alt="CUPiD Config 1" width=1000 />