Skip to content

Fixed an issue where footnote references were being rendered without brackets #27

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
Oct 24, 2022

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Oct 21, 2022

Context: This was previously fixed in the QML repo, but the fix must have been accidentally reverted when porting to the Xanadu Sphinx Theme.

Description of the Change: As title.

Benefits: As title.

Possible Drawbacks: n/a

Related GitHub Issues: n/a

@josh146
Copy link
Member Author

josh146 commented Oct 21, 2022

See this page in the XST docs for an example of references: https://xanadu-sphinx-theme--27.org.readthedocs.build/en/27/gallery/tutorial_demo.html

Copy link
Collaborator

@Mandrenkov Mandrenkov left a comment

Choose a reason for hiding this comment

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

Looks reasonable to me but is the vertical offset expected? 🤔

image

@josh146
Copy link
Member Author

josh146 commented Oct 22, 2022

Yep, unfortunately it's a stylistic change that Sphinx made in versions 2.0+.

Versions <2.0 render the reference number to the left of the reference text, not above

@josh146 josh146 merged commit 7ed4717 into master Oct 24, 2022
@josh146 josh146 deleted the fix-references branch October 24, 2022 15:08
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.

2 participants