From Lucas:
I've been working in tidy3d and I use the terminal help quite more often than the web docs. The new documentation look a lot worse there; it's very hard to read parameter types and default values (and this is for Box, which has only 2 parameters):
Help on class Box in module tidy3d.components.geometry.base:
Do we care about those help channels? If so, I think all the table for parameters markup should be implemented through sphinx extensions, not directly in the source.
Yeah doesn't look great there.
Hmm sounds good, let me think how to consolidate things. This is the rst generated from Base.generate_docstrings() . We actually were chatting about potentially also implementing the same thing using a sphinx template file, but was a bit more involved to implement - so I just extended the existing function.
However, it seems like it might be more valuable to keep the source rst fully separate as that would help support these other help styles. I'll put this in my issue list and reimplement this as I agree with what you're suggesting on support too (edited)
From Lucas:
I've been working in tidy3d and I use the terminal help quite more often than the web docs. The new documentation look a lot worse there; it's very hard to read parameter types and default values (and this is for Box, which has only 2 parameters):
Help on class Box in module tidy3d.components.geometry.base:
Do we care about those help channels? If so, I think all the table for parameters markup should be implemented through sphinx extensions, not directly in the source.