Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
TeaganKing opened this issue Sep 10, 2024 · 2 comments · Fixed by #134
Assignees

Comments

@TeaganKing
Copy link
Collaborator

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.

@TeaganKing TeaganKing self-assigned this Sep 10, 2024
@mnlevy1981
Copy link
Collaborator

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
Copy link
Collaborator

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 />

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants