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.

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

Already on GitHub? Sign in to your account

Use sphinx-codeautolink in docs? #7010

Open
TomNicholas opened this issue Sep 8, 2022 · 4 comments 路 May be fixed by #7011
Open

Use sphinx-codeautolink in docs? #7010

TomNicholas opened this issue Sep 8, 2022 · 4 comments 路 May be fixed by #7011

Comments

@TomNicholas
Copy link
Contributor

TomNicholas commented Sep 8, 2022

I'm a big fan of sphinx-codeautolink 馃檪

Originally posted by @Zac-HD in #6908 (comment)

This looks cool, lets add it!

@dcherian
Copy link
Contributor

dcherian commented Sep 9, 2022

I tried this with xarray-tutorial a few months ago (xarray-contrib/xarray-tutorial#85) and it was quite frustrating: I kept hovering over things that didn't show popups. Though there's been some recent development, so perhaps its better now.

Did you try it out?

@felix-hilden
Copy link

felix-hilden commented Sep 11, 2022

Hi, I've indeed implemented links for assignment targets, bare names and annotated function arguments recently. The changes are still unreleased though, because I want to include match support in the same batch (felix-hilden/sphinx-codeautolink#110). Feel free to try "master" meanwhile, but I'll let you know when it's released 馃憤 (to stop this stalking and/or harassment, press 馃殌)

@dcherian
Copy link
Contributor

to stop this stalking and/or harassment,

Hi @felix-hilden I really appreciate your comments!

I love the idea of the package but just want to be conservative before rolling it out.

@felix-hilden
Copy link

Yeah I was just messing around 馃槃 Being conservative with random packages is advised. Buuut, 0.12 released just now with the extra links! Lemme know how it goes 馃憤

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants