idaes-pse
idaes-pse copied to clipboard
IDAES
Modeling extensions - splash page
@adowling2 proposed creating a "splash page" for all the modeling extensions for IDAES. The idea behind this was to have a 3-5 sentence description with a figure for each modeling extension in the user guide (docs/user_guide/modeling_extensions/index.rst).
The things we are considering to be modeling extensions include: all the surrogate tools, matopt, mpc, and caprese.
Please provide this description and image in the user_guide/modeling_extensions/index.rst file. The image should be placed in the docs/_images folder and can be placed in the rst file with the follow:
.. image:: ../../../_images/<image name>.png
:width: <desired size in pixels (e.g. 600px)>
The currently added splash, MatOpt, adds a line to the TOC on the left side of the page. I don't think this is what was intended.
@mengleCMU yes there are a couple of other places where that happens. The fix will be to hide the toc tree and then just create headers. I'll make an issue to address this and at other places, thank you for reminding me.
What you added in IDAES/idaes-dev#1008 is exactly what I was going to do for Caprese.
