sphinx-doc / sphinx-doc/sphinx

code-block goes beyond the bottom border after wrapping

Open
#10,375 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

html theme type:bug
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

When the code-block content wraps, it goes beyond the bottom border

How to Reproduce

.. code-block:: c

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx {
aaaaaaaaaaaaaaaaaaaaaaaaaaa
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
ccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
}
\sphinxsetup{verbatimforcewraps=true,verbatimmaxunderfull=2,
verbatimwithframe=false,
verbatimwrapslines=true,
verbatimhintsturnover=false,
}

Expected behavior

No response

Your project

rst

Screenshots

image

OS

ubuntu

Python version

3.8.10

Sphinx version

4.5.0

Sphinx extensions

no

Extra tools

No response

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with the provided RST code block and verbatim settings using Sphinx 4.5.0 on Ubuntu, then trace the code-block wrapping and frame rendering behavior. Done means wrapped content stays within the block's bottom border.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.