Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Fix footnote styles to work with latest Sphinx + docutils #488

Closed
1 task done
jab opened this issue Jul 26, 2022 · 0 comments
Closed
1 task done

Fix footnote styles to work with latest Sphinx + docutils #488

jab opened this issue Jul 26, 2022 · 0 comments

Comments

@jab
Copy link
Contributor

jab commented Jul 26, 2022

What's happening?

A new version of Sphinx has now been released, which changes its dependency pins to allow docutils 0.19, which includes a fix for New HTML markup for footnotes is difficult to stylise, along with corresponding Sphinx changes.

Now that both Sphinx and docutils have made stable releases to address this issue, I believe Furo is no longer blocked from writing styles that fix the regression in footnote alignment that was caused by the changes in docutils 0.18. (The latest version of Furo is still causing the broken looking footnotes that are visible in this screenshot when used with latest Sphinx (5.1.1) and docutils (0.19).)

Reproducer

  1. Build Sphinx documentation at https://github.com/jab/bidict by running pip install -r requirements/docs.txt && make -C docs html from a fresh clone.
  2. Open docs/_build/html/index.html in a browser.
  3. Scroll down to the footnotes at the bottom of the page.
  4. Observe that (1) footnotes are no longer appearing on the same line as their corresponding footnote numbers, and (2), they're not even being indented consistently: Note how footnote 3 is not indented, while footnotes 1, 2, and 4 are indented:

Ref: #452

Expectation

Alignment of footnotes stays consistent and correct, as it appeared before the changes introduced in docutils 0.18 caused this breakage:

Code of Conduct

Repository owner locked and limited conversation to collaborators Jul 27, 2022
@pradyunsg pradyunsg converted this issue into discussion #489 Jul 27, 2022

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant