lamkina commented 1 year ago

Purpose

This PR uses the sphinx extensions added to sphinx_mdolab_theme that were originally from OpenMDAO v3.9.2. The purpose is to use these extensions to have code blocks run dynamically when we build the docs and generate necessary outputs automatically. This replaces the current static documentation format.

Expected time until merged

This is a non-urgent PR and might take some time to iron out all the bugs and clean up the docs and comments in the testing code.

Type of change

[ ] Bugfix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (non-backwards-compatible fix or feature)
[ ] Code style update (formatting, renaming)
[x] Refactoring (no functional changes, no API changes)
[x] Documentation update
[ ] Maintenance update
[ ] Other (please describe)

Testing

The only testing for this PR is building the docs and making sure they look correct with the new extensions.

Checklist

[x] I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
[x] I have run unit and regression tests which pass locally with my changes
[ ] I have added new tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation

codecov[bot] commented 1 year ago

Codecov Report

Merging #389 (0a4ee0e) into main (614dc6a) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #389   +/-   ##
=======================================
  Coverage   96.63%   96.63%           
=======================================
  Files          93       93           
  Lines        6009     6009           
=======================================
  Hits         5807     5807           
  Misses        202      202

:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

eytanadler commented 1 year ago

I agree that it's better to have the output there in the docs. I didn't comment in every place that it was missed, do you mind adding in a :layout: everywhere it's relevant? For example the multipoint optimization doesn't show the output.