Docs update

[lamkina]

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)
• Refactoring (no functional changes, no API changes)
• 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

• I have run flake8 and black to make sure the code adheres to PEP-8 and is consistently formatted
• 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
• I have added necessary documentation

[codecov]

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           

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

[eytanadler]

Overall this is a great improvement and really cleans up the code, thanks Andrew!

One question: do we have control over the output font size? It looks substantially bigger than the code or rest of the docs.

[eytanadler]

Also doesn't look like anything is printed out here? Is that the intended behavior if there is no :layout: specified?

[lamkina]

I can specify a layout for these if we want the output. I think I added the output manually when I went made the initial docs update. The older version of the docs didn't include the output.

[eytanadler]

Personally I don't think it'd hurt given how easy it is. Anyone else have thoughts? @kanekosh?

[lamkina]

I'll do it for now. I think the output makes it easier for people to compare their scripts when they are learning the examples.

[kanekosh]

I agree that it’s better to print the output values here.

[eytanadler]

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.

[eytanadler]

@kanekosh do you mind taking a quick look at this before we merge?

[kanekosh]

Thank you @lamkina!