Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make PTT subduction_convergence docstrings compatible with pdoc3 #210

Open
michaelchin opened this issue Jun 30, 2024 · 2 comments
Open

make PTT subduction_convergence docstrings compatible with pdoc3 #210

michaelchin opened this issue Jun 30, 2024 · 2 comments
Labels
enhancement New feature or request low

Comments

@michaelchin
Copy link
Contributor

Screenshot 2024-06-30 at 3 41 26 PM
@michaelchin michaelchin added enhancement New feature or request low labels Jun 30, 2024
@brmather
Copy link
Collaborator

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
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request low
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@michaelchin @brmather