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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MAINT: fixes to tabbed examples in docs #1379

Merged
merged 4 commits into from
Jul 3, 2023
Merged

Conversation

drammock
Copy link
Collaborator

@drammock drammock commented Jul 3, 2023

follow-up to #1373, which was merged before I could get my review submitted

@drammock drammock added kind: documentation Improvements or additions to documentation tag: accessibility Issues related to accessibility issues or efforts labels Jul 3, 2023
@drammock drammock requested a review from 12rambau July 3, 2023 15:48
@drammock drammock changed the title Follow up MAINT: fixes to tabbed examples in docs Jul 3, 2023
Comment on lines +38 to +40
---
caption: '`conf.py`'
---
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this workaround prevents "conf.py" from being turned into a link to https://conf.py

I haven't been able to determine what causes the unwanted linking; I think it might be Myst-Parser because the caption "MANIFEST.in" on this page of the sphinx documentation does not become a link; so I'm wondering if it's an rST source versus MD source thing.

docs/user_guide/static_assets.md Show resolved Hide resolved
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes to this file add an overline to the tab labels on hover, so that we're not relying only on color change to signal interactivity. cc @trallard in case overlines are considered bad or there's some better way to signal this.

@drammock
Copy link
Collaborator Author

drammock commented Jul 3, 2023

CIs are all green, this one's ready for review/merge. Here's a link to the tabbed example that changed the most: https://pydata-sphinx-theme--1379.org.readthedocs.build/en/1379/user_guide/static_assets.html#add-it-directly-to-the-page-content

Copy link
Collaborator

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a nice improvement to me! I couldn't find any bugs in there. +1

@trallard
Copy link
Collaborator

trallard commented Jul 3, 2023

Thank you! This is a component I had marked for improvements.
I think this is a good first iteration so we can merge.

Copy link
Collaborator

@12rambau 12rambau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM sorry to have close the other PR prior to your review

@12rambau 12rambau merged commit 92445e9 into pydata:main Jul 3, 2023
15 checks passed
@drammock drammock deleted the follow-up branch August 1, 2023 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Improvements or additions to documentation tag: accessibility Issues related to accessibility issues or efforts
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants