fix for configuration file documentation images #134
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TeaganKing
added
bug
mnlevy1981
reviewed
Sep 10, 2024
docs/conf.py
Outdated
Comment on lines
38
to
47
| # Copy images into ${CUPID}/docs/_static/images/ | ||
| for file in [ | ||
| "config_1.png", | ||
| "config_2.png", | ||
| "config_3.png", | ||
| "config_4.png", | ||
| "config_5.png", | ||
| ]: | ||
| os.system(f"cp ../images/{file} ../docs/_static/images/") | ||
|
|
There was a problem hiding this comment.
Looking a little closer, docs/_static/images/ is under version control in this repository... can we just do a single
$ git mv images/* docs/_static/images/Instead of having this copy in conf.py? Given the current structure of _static/ it might even make sense to move them to docs/_static/images/config/ and then update config.md to point to the new location.
There was a problem hiding this comment.
Good idea! I just made that change. Things still build as expected locally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This addresses #133 to ensure that images are rendering correctly in the configuration file documentation page. This works locally.
pre-commitcheck)?Note there was a slight modification from @mnlevy1981 's suggestion in order for this to work properly during testing.
[_static/images/config_1.png](view-source:https://ncar.github.io/images/config_1.png)-->_static/images/config_1.png