Removed need for copy_build_artifacts in the doc build process. #1100
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
… use HTML instead from IPython.display
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
swryan
reviewed
Aug 14, 2024
| " saved_coloring_dir = f'coloring_files{stfd}{stpc}'\n", | ||
| " if os.path.exists(saved_coloring_dir):\n", | ||
| " shutil.rmtree(saved_coloring_dir)\n", | ||
| " shutil.move(p.get_coloring_dir(mode='output'), saved_coloring_dir)\n", |
There was a problem hiding this comment.
per CI failure.. this requires OpenMDAO 3.34.3-dev
robfalck
force-pushed
the
build_artifacts_refactor
branch
from
92b21bf to
2a56af7
Compare
swryan
approved these changes
Aug 15, 2024
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.
Summary
copy_build_artifacts.pywas used to copy over html files, images, and other files for the documentation. This functionality was mostly needed with older versions of jupyterbook and when IFrame was used for the display of content.Using
ipython.display.HTMLinstead causes the displayed files to be included in the _build directory without copying over everything.This should have a significant impact on the size of the documentation generated.
Note that when using
ipython.display.HTML, the output should be wrapped in a div with the height included so that jupterbook doesn't make the output cell too short to be useful.Related Issues
copy_build_artifacts.pyto copy over all outputs during doc build process. #1099Backwards incompatibilities
None
New Dependencies
None