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

broken alignment for captions in toctrees in ver. 0.5.1 #1112

Closed
AngryMaciek opened this issue Apr 4, 2021 · 6 comments
Closed

broken alignment for captions in toctrees in ver. 0.5.1 #1112

AngryMaciek opened this issue Apr 4, 2021 · 6 comments
Labels
Bug A bug Priority: high High priority

Comments

@AngryMaciek
Copy link

Problem

I have been using the older version 0.4.3 and had a nice toctrees like below:
Screenshot 2021-04-05 at 00 13 22

However, the search functionality was bugged so I updated to 0.5.1 and now I get:
Screenshot 2021-04-05 at 00 13 33

And it seems to me that the captions for both toctree elements is not aligned anymore. Neither horizontally nor vertically (werid space between the caption and the first section, no space between last section of the previous toctree and a new one).

Reproducible Project

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: General Information

   custom/installation
   custom/background
   custom/example-results
   custom/citing-contributing
   custom/changelog
   custom/license

.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: API

   custom/users-api
   custom/internal-api

Expected Results

I would like to have a page layout just like for 0.4.3.

Environment Info

  • Python Version: 3.7.4
  • Sphinx Version: 3.5.3
  • RTD Theme Version: 0.5.1
@AngryMaciek AngryMaciek added Bug A bug Needed: replication Bug replication is required labels Apr 4, 2021
@AngryMaciek AngryMaciek mentioned this issue Apr 4, 2021
Closed
@Blendify Blendify mentioned this issue Apr 5, 2021
Closed
@JWCook
Copy link

JWCook commented Apr 5, 2021

This seems to be related to the release of docutils 0.17: https://docutils.sourceforge.io/RELEASE-NOTES.html#id46

@Blendify
Copy link
Member

Blendify commented Apr 5, 2021

This is caused by a recent release of docutils 0.17 if you pin 0.16 in a pip install requirements it should fix the issue.

rtd should fix this globally but that solution would work for you individually. I have a patch here that fixes this for the theme: #1113 if this gets merged/released it should fix the issue.

There also seems to be a fix in sphinx: sphinx-doc/sphinx#9001 the fix for that might also fix this issue.

@Blendify
Copy link
Member

Blendify commented Apr 5, 2021

See also #1111

@Blendify Blendify mentioned this issue Apr 5, 2021
Closed
@Blendify
Copy link
Member

Blendify commented Apr 5, 2021

See the rtd documentation here on how to pin a dependency: https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html#pinning-dependencies
The line in the requirements file should be:

docutils<0.17

I have reached out to the team at rtd, this should be fixed on the server-side / in the theme. If you do pin to an old version be prepared to revert that change once this has been fixed on a more global level.

@Blendify Blendify added Priority: high High priority and removed Needed: replication Bug replication is required labels Apr 5, 2021
@seisman seisman mentioned this issue Apr 5, 2021
Closed
@AngryMaciek
Copy link
Author

AngryMaciek commented Apr 5, 2021 •
edited
Loading

Thank you very much for the prompt response!
Indeed, docutils==0.16 solved the issue :)

@Blendify
Copy link
Member

Blendify commented Apr 5, 2021

This has been fixed with RTD Theme Version 0.5.2

@Blendify Blendify closed this as completed Apr 5, 2021
@rkdarst rkdarst mentioned this issue Apr 5, 2021
Closed
@diox diox mentioned this issue Apr 9, 2021
Closed
@andersk andersk mentioned this issue May 8, 2021
Merged
@potiuk potiuk mentioned this issue May 28, 2021
Merged
potiuk added a commit to potiuk/airflow that referenced this issue May 28, 2021
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed
c9a59bf 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112
potiuk added a commit to apache/airflow that referenced this issue May 28, 2021
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
6fd9c01 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112
potiuk added a commit to potiuk/airflow that referenced this issue Jun 22, 2021
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (apache#16133)
1205b4d 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112
(cherry picked from commit 6fd9c01)
fengguang pushed a commit to 0day-ci/linux that referenced this issue Jul 27, 2021
@akiyks @intel-lab-lkp
docs: Set upper limit of docutils (<0.17)
4b834fd 
sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements.
docutils 0.17 was released this April and caused regression in
sphinx_rtd_theme 0.5.1 [1].
Put the same limit in sphinx/requirements.txt.

[1]: readthedocs/sphinx_rtd_theme#1112

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
@mradamcox mradamcox mentioned this issue Aug 2, 2021
Closed
fengguang pushed a commit to 0day-ci/linux that referenced this issue Aug 13, 2021
@akiyks
docs: sphinx-requirements: Move sphinx_rtd_theme to top
37397b0 
sphinx_rtd_theme 0.5.2 has "docutils<0.17" in its requirements.
docutils 0.17 released this April caused regression in
sphinx_rtd_theme 0.5.1 [1].

By removing docutils and moving sphinx_rtd_theme before Sphinx in
requirements.txt, the requirement of "docutils<0.17" can be met
naturally.

[1]: readthedocs/sphinx_rtd_theme#1112

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/75f14c88-6091-1072-41cb-16b886aee5a0@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Sep 17, 2021
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
bca99d9 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112
(cherry picked from commit 6fd9c01159aeba132d7b0f7ef3949dd0049a0392)

GitOrigin-RevId: 1205b4de9c45eddd4b1a71c285f2addf93c8a83b
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Sep 23, 2021
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
9a4beef 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112
(cherry picked from commit 6fd9c01159aeba132d7b0f7ef3949dd0049a0392)

GitOrigin-RevId: 1205b4de9c45eddd4b1a71c285f2addf93c8a83b
dfelinto pushed a commit to dfelinto/blender-manual that referenced this issue Oct 14, 2021
Pip: Force old version of docutils
961a52c 
Docutils 0.17 causes issues with the theme see:
readthedocs/sphinx_rtd_theme#1112

Until this is fixed in the theme/sphinx we need to
pin an old version.


git-svn-id: https://svn.blender.org/svnroot/bf-manual/trunk/blender_docs@7919 c4de1f47-6596-e411-a384-0024e86c2797
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Nov 27, 2021
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
ac92339 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112
(cherry picked from commit 6fd9c01159aeba132d7b0f7ef3949dd0049a0392)

GitOrigin-RevId: 1205b4de9c45eddd4b1a71c285f2addf93c8a83b
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Mar 10, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
8804076 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Jun 4, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
d376df0 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Jul 10, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
66d704e 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Aug 27, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
7f810b8 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Oct 4, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
868fbc5 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
aglipska pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Oct 7, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
e7c335a 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
This was referenced Nov 4, 2022
Open
Merged
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Dec 7, 2022
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
a569937 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
leahecole pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Jan 27, 2023
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
3c61be0 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
kosteev pushed a commit to kosteev/composer-airflow-test-copybara that referenced this issue Sep 12, 2024
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
684be6e 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
kosteev pushed a commit to kosteev/composer-airflow-test-copybara that referenced this issue Sep 13, 2024
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
84d5d0b 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Sep 17, 2024
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
f975bf8 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
kosteev pushed a commit to GoogleCloudPlatform/composer-airflow that referenced this issue Nov 7, 2024
@potiuk
Pins docutils to <0.17 until breaking behaviour is fixed (#16133)
9666052 
Sphinx RTD theme 0.5.2. introduced limitation to docutils to account for
some docutils markup change:

readthedocs/sphinx_rtd_theme#1112

GitOrigin-RevId: 6fd9c01159aeba132d7b0f7ef3949dd0049a0392
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug A bug Priority: high High priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Setup: Require docutils<0.17' readthedocs/sphinx_rtd_theme
3 participants
@JWCook @Blendify @AngryMaciek