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

ENH: Add MyST support and tests for ref labels #91

Merged
merged 3 commits into from
Jan 3, 2024
Merged

ENH: Add MyST support and tests for ref labels #91

merged 3 commits into from
Jan 3, 2024

Conversation

JWCook
Copy link
Collaborator

@JWCook JWCook commented Jan 2, 2024 •
edited
Loading

Closes #85; Follow-up from #86

Notes:

  • Added explicit ref label for MyST tag pages so the same label can be used for either format
  • Added ref label above page header, so ref links use the header as the default label instead of the toctree title (e.g., "Tag: tag_1" instead of "pages with this tag")
  • On quickstart page, added tabs to switch between usage examples for rST and MyST
  • Unrelated change: Pinned minimum version of pydata-sphinx-theme due to UndefinedError("'logo' is undefined") errors. See: Sphinx 6.0.0: Theme Error: Reason: UndefinedError("'logo' is undefined") pydata/pydata-sphinx-theme#1094

@JWCook JWCook marked this pull request as ready for review January 2, 2024 21:48
@JWCook
Copy link
Collaborator Author

JWCook commented Jan 2, 2024

@lucyleeow Does this look reasonable to you?

@JWCook JWCook changed the title Add MyST support and tests for ref labels ENH: Add MyST support and tests for ref labels Jan 2, 2024
lucyleeow
lucyleeow reviewed Jan 3, 2024
View reviewed changes
Copy link
Contributor

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for adding a test. Just one comment

src/sphinx_tags/__init__.py Show resolved Hide resolved
@JWCook JWCook merged commit 67ac825 into melissawm:main Jan 3, 2024
2 checks passed
@JWCook JWCook deleted the ref_label_myst branch January 3, 2024 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lucyleeow lucyleeow lucyleeow left review comments

@story645 story645 story645 approved these changes

@melissawm melissawm Awaiting requested review from melissawm

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ENH Add reference label to tags page headers
3 participants
@JWCook @story645 @lucyleeow