-
Notifications
You must be signed in to change notification settings - Fork 213
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.
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
Hyperlink to parameters in docstrings using sphinx-paramlinks #2132
Comments
Looks great! |
I like the look as well but am hesitant to rely on an experimental extension that would require a fair amount of work to drop. |
I'm closing the issue as the sphinx-paramlinks extension is not actively maintained. The latest tag (https://github.com/sqlalchemyorg/sphinx-paramlinks/tags) was created one year ago and there is only one commit in the recent year. Feel free to reopen it if there are any more updates on the extension or any new ideas. |
Description of the desired feature
To make it easier to reference the parameters of PyGMT functions (e.g.
pen
inplot
), here's an idea to make all those parameters clickable with a permalink! This can be done usingsphinx-paramlinks
.Pros:
Cons:
:paramref:
directivesphinx-paramlinks
extension doesn't look well maintained (last commit 31 May 2022), though there are supposedly 300+ usersThere's a proof of concept PR at #2131 to show how the implementation looks like.
Are you willing to help implement and maintain this feature? Discuss on whether the pain is worth it 🙂
Vote 👍 for yes, 👎 for no
If we do go ahead, the concrete steps would be to:
sphinx-paramlinks
package to conda-forge (optional, but nice to have)<insert long list of PyGMT functions whose docstrings need to be rewriten
>The text was updated successfully, but these errors were encountered: