10000 [MRG] CSS: add a CSS class to links in code by GaelVaroquaux · Pull Request #145 · sphinx-gallery/sphinx-gallery · GitHub
[go: up one dir, main page]

Skip to content

[MRG] CSS: add a CSS class to links in code #145

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

Merged
merged 2 commits into from
Sep 16, 2016

Conversation

GaelVaroquaux
Copy link
Contributor

The goal is to enable downstream to style the doc-resolv links in code examples specially.

The goal is to enable downstream to style the doc-resolv links in code
examples specially.
@GaelVaroquaux
Copy link
Contributor Author

To make this functionality more discoverable, I've added a title to the link, that hints to what the link points to, and CSS code so that the title appears with no delay when the user hovers:
image

@Titan-C
Copy link
Member
Titan-C commented Sep 15, 2016

this looks very nice

@GaelVaroquaux GaelVaroquaux changed the title CSS: add a CSS class to links in code [MRG] CSS: add a CSS class to links in code Sep 15, 2016
@lesteve
Copy link
Member
lesteve commented Sep 16, 2016

Very nice indeed!

@Titan-C I don't remember does readthedocs build on each PR or only on each commit into master? It would be nice to see the generated sphinx-gallery doc on PRs ...

@lesteve lesteve merged commit a0669db into sphinx-gallery:master Sep 16, 2016
@lesteve
Copy link
Member
lesteve commented Sep 16, 2016

Merged thanks.

@lesteve
Copy link
Member
lesteve commented Sep 16, 2016

Hmmm actually I should have tested this a bit more I get two popups for some reason (both locally and on readthedocs). Here is a snapshot:

sphinx-gallery

@GaelVaroquaux
Copy link
Contributor Author
GaelVaroquaux commented Sep 16, 2016 via email

@lesteve
Copy link
Member
lesteve commented Sep 16, 2016

I actually really hate readthedocs because it makes it so hard to test things without merging.

In this case I get this locally too though. In this case I'll blame myself for merging while blindly trusting someone ;-).

@lesteve
Copy link
Member
lesteve commented Sep 16, 2016

Having said that it'd be great if we could use the readthedocs theme so that it looks the same locally and on readthedocs ... no idea whether it's difficult or not.

@GaelVaroquaux
Copy link
Contributor Author

We have two issues here:

  • wordbreaks don't happen correctly. That's easy to fix. I've fixed it
    locally
  • there is a second popup, generated by the browser. To fix this, I might
    need to use a different attribute than "title". That's a bummer,
    because "title" is used by readers for blind people. I'll investigate
    more.

GaelVaroquaux added a commit to GaelVaroquaux/sphinx-gallery that referenced this pull request Sep 16, 2016
@GaelVaroquaux GaelVaroquaux mentioned this pull request Sep 16, 2016
@GaelVaroquaux
Copy link
Contributor Author
8000 GaelVaroquaux commented Sep 16, 2016

That's a bummer, because "title" is used by readers for blind people.

Apparently that's not always the case.
https://silktide.com/i-thought-title-text-improved-accessibility-i-was-wrong/

I've pushed a fix on
#146

lesteve added a commit that referenced this pull request Sep 16, 2016
Fixed double tooltip problem as mentioned in #145.
@Titan-C
Copy link
Member
Titan-C commented Sep 16, 2016

I don't remember does readthedocs build on each PR or only on each commit into master? It would be nice to see the generated sphinx-gallery doc on PRs ...

readthedocs only builds after is pushed into master and for every commit to which version tag is put.

I'm also thinking in having the docs build in CircleCI as you do in nilearn/scikit-learn

@Titan-C
Copy link
Member
Titan-C commented Sep 16, 2016

it'd be great if we could use the readthedocs theme so that it looks the same locally and on readthedocs ... no idea whether it's difficult or not.

I do that manually from time to time. I can set it up as part of our configuration. It will of course require you have the readthedocs theme installed(is in conda and pip)

@GaelVaroquaux
Copy link
Contributor Author
GaelVaroquaux commented Sep 16, 2016 via email

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

Successfully merging this pull request may close these issues.

3 participants
0