search

GPlates / gplately

GPlately is a Python package to interrogate tectonic plate reconstructions.
https://gplates.github.io/gplately/
GNU General Public License v2.0
60 stars 13 forks source link

make PTT subduction_convergence docstrings compatible with pdoc3 #210

Open michaelchin opened 4 months ago

michaelchin commented 4 months ago
Screenshot 2024-06-30 at 3 41 26 PM
brmather commented 4 months ago

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...

michaelchin commented 4 months ago

Used this https://pypi.org/project/pyment/ before. Forgot if it was good or bad. Worth a try.

brmather commented 2 months ago

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?

jcannon-gplates commented 2 months ago

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?

michaelchin commented 2 months ago

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.

brmather commented 2 months ago

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!