search

OpenMDAO / dymos

Open Source Optimization of Dynamic Multidisciplinary Systems
Apache License 2.0
202 stars 65 forks source link

Removed need for copy_build_artifacts in the doc build process. #1100

Closed robfalck closed 1 month ago

robfalck commented 1 month ago

Summary

copy_build_artifacts.py was 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.HTML instead 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

Backwards incompatibilities

None

New Dependencies

None

review-notebook-app[bot] commented 1 month ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

coveralls commented 1 month ago

Coverage Status

coverage: 92.528% (-0.2%) from 92.733% when pulling 2a56af72069156eb88d1192e5b45da970e9ca378 on robfalck:build_artifacts_refactor into be40d1458e2de8cac311119aae4c9803e6e23d6f on OpenMDAO:master.