GPlates
make PTT subduction_convergence docstrings compatible with pdoc3
The pygplates documentation was generated from sphinx which relies on its own markup. There may be some way to instruct pdoc3 to render sphinx style documentation, otherwise it would require manual alteration of docstrings...
Used this https://pypi.org/project/pyment/ before. Forgot if it was good or bad. Worth a try.
PTT is now bundled into gplately, so it may make sense to translate the sphinx markup to pdoc3 compatible documentation. Perhaps a job for an RA @michaelchin?
so it may make sense to translate the sphinx markup to pdoc3 compatible documentation
I think having someone go through and change the PTT docstrings sounds like a good idea.
The PPT docstrings are a bit of a mixed bag. I think the subduction convergence (you show above) uses numpydoc format (which, from what I can tell, is what gplately is currently using) - but I must've kept the sphinx table in there by mistake. And other PTT files probably not in any specific format, so need to be converted to numpydoc.
Can I ask - is numpydoc the official docstring format for gplately?
PTT is now bundled into gplately, so it may make sense to translate the sphinx markup to pdoc3 compatible documentation. Perhaps a job for an RA @michaelchin?
Good idea! Let's find a RA.
OK, let's flag this at the next GPlates meeting.
Can I ask - is numpydoc the official docstring format for gplately?
Yes, numpydoc is what we've been trying to adhere to!