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

Citations not spanning whole doc area with sphinx-rtd-theme version 1.3.0 #1540

Open
saurabheights opened this issue Nov 4, 2023 · 1 comment
Labels
Bug A bug Needed: replication Bug replication is required

Comments

@saurabheights
Copy link

Problem

Citations layout is incorrect and works differently with or without new lines.

Reproducible Project

See below rst code. The first three citation are from https://github.com/readthedocs/sphinx_rtd_theme/blob/master/docs/demo/demo.rst#citations, rest are taken from Open3d which is built using v0.4.3 of sphinx_rtd_theme. I am upgrading their tech stack, but noticed references dont work when upgrading sphinx_rtd_theme. I have taken 3 of the references and added them, with and without new lines.

Citations
---------

.. [Citation] This is the citation I made, let's make this extremely long so that we can tell that it doesn't follow the normal responsive table stuff.

.. [12] This citation has some ``code blocks`` in it, maybe some **bold** and
       *italics* too. Heck, lets put a link to a meta citation [13]_ too.

.. [13] This citation will have two backlinks.

.. [ArujoAndOliveira2020] A. Arajo and M. Oliveira,
   A robust statistics approach for plane detection in unorganized point clouds, Pattern Recognition, 2020

.. [ArujoAndOliveira2020] A. Arajo and M. Oliveira, A robust statistics approach for plane detection in unorganized point clouds, Pattern Recognition, 2020

.. [Bernardini1999] F. Bernardini and J. Mittleman and HRushmeier and C. Silva and G. Taubin
   The ball-pivoting algorithm for surface reconstruction, IEEE transactions on visualization and computer graphics, 5(4), 349-359, 1999

.. [Bernardini1999] F. Bernardini and J. Mittleman and HRushmeier and C. Silva and G. Taubin, The ball-pivoting algorithm for surface reconstruction, IEEE transactions on visualization and computer graphics, 5(4), 349-359,
   1999

.. [ChenAndMedioni1992] Y. Chen and G. G. Medioni,
   Object modelling by registration of multiple range images, Image and Vision Computing, 10(3), 1992.

.. [ChenAndMedioni1992] Y. Chen and G. G. Medioni, Object modelling by registration of multiple range images, Image and Vision Computing, 10(3), 1992.

Notice that in case of Bernardini1999, adding a new line just before 1999 makes the citation layout work.

Error Logs/Results

Both error and expected results are below.

image

Environment Info

  • Python Version: 3.8
  • Sphinx Version: 7.1.2
  • RTD Theme Version: 1.3.0

Setup done in fresh conda environment

conda create --name docs python=3.8 -y
conda activate docs
pip install sphinx-rtd-theme==1.3.0
sphinx-build -b html . _out
@saurabheights saurabheights added Bug A bug Needed: replication Bug replication is required labels Nov 4, 2023
@saurabheights saurabheights changed the title Citations not working with sphinx-rtd-theme version 1.3.0 Citations not spanning whole doc area with sphinx-rtd-theme version 1.3.0 Nov 4, 2023
@saurabheights
Copy link
Author

Copy pasting citation, I ended up using citation with same label, i.e. ChenAndMedioni1992 is used twice. However making them unique doesnt help.

Also, notice how the css is different for last two citations.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug A bug Needed: replication Bug replication is required
Projects
None yet
Development

No branches or pull requests

1 participant