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

toctree caption paragraphs miss the "caption" class #1111

Closed
ocharles opened this issue Apr 3, 2021 · 5 comments
Closed

toctree caption paragraphs miss the "caption" class #1111

ocharles opened this issue Apr 3, 2021 · 5 comments
Labels
Bug A bug Needed: replication Bug replication is required

Comments

@ocharles
Copy link

ocharles commented Apr 3, 2021

Problem

toctrees with captions are currently displayed as a raw <p> tag (in HTML output), without the caption class.

Reproducible Project

https://rel8.readthedocs.io/en/latest/

Note the captions on each toctree in the sidebar are too big, and lack the correct colour:

image

This is as-of https://github.com/circuithub/rel8/tree/6a3913b2b625724fbd67554b3cc1e3eb428f45de/docs

Expected Results

The sidebar looks more like the sidebar in the documentation for this theme:

image

@ocharles ocharles added Bug A bug Needed: replication Bug replication is required labels Apr 3, 2021
@ocharles
Copy link
Author

ocharles commented Apr 3, 2021

I note that the p elements also don't have caption in the default theme either, so maybe this is a Sphinx bug?

@Blendify
Copy link
Member

Blendify commented Apr 3, 2021

From initial tests I think this is due to docutils 0.17 being installed. I am transferring the issue to the main rtd repository, docutils 0.17 should not be installed, sphinx has issues with it and I don't think it will be supported until sphinx 4.0.

@Daltz333
Copy link

Daltz333 commented Apr 4, 2021

Corresponding Sphinx issue sphinx-doc/sphinx#9001

The fix is just to pin the docutils dependency to 0.16.0...

in your requirements.txt (you should be using one!) add

docutils==0.16.0

@ocharles
Copy link
Author

ocharles commented Apr 4, 2021

Thanks folks, I'll pin docutils. Thanks!

ocharles added a commit to circuithub/rel8 that referenced this issue Apr 4, 2021
@ocharles
Copy link
Author

ocharles commented Apr 4, 2021

Ok, adding that pin has solved the problem. Thanks again!

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

3 participants