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

code-block captions are not displayed correctly in man pages #3859

Closed
zjs opened this issue Jun 8, 2017 · 1 comment
Closed

code-block captions are not displayed correctly in man pages #3859

zjs opened this issue Jun 8, 2017 · 1 comment

Comments

@zjs
Copy link

zjs commented Jun 8, 2017

Problem

code-block captions are not displayed correctly in man pages

Procedure to reproduce the problem

Run the following:

mkdir /tmp/code-block-test
cd /tmp/code-block-test
yes "n" | sphinx-quickstart --dot _ --project code-block-test --author "Example" -v 0 --release 0 --language en --suffix .rst --master index --makefile --batchfile docs
echo '
Below is an example of a codeblock with a caption.

.. code-block:: bash
   :caption: This is a caption

   echo 1234
' >> docs/index.rst
make -C docs man

Error logs / results

The rendered man page contains:

       Below is an example of a codeblock with a caption. This is a caption.INDENT 0.0

          echo 1234

Expected results

".INDENT 0.0" should not appear in the man page.

I would expect the rendered version of the man page to look more like:

       Below is an example of a codeblock with a caption.

       This is a caption

          echo 1234

(This would be consistent with the behavior of html and latexpdf.)

Reproducible project / your project

See above.

Environment info

  • OS: Ubuntu 16.04 LTS
  • Python version: Python 2.7.12
  • Sphinx version: Sphinx v1.5.6
@tk0miya tk0miya added this to the 1.6.3 milestone Jun 10, 2017
@tk0miya tk0miya modified the milestones: 1.6.4, 1.6.3 Jun 24, 2017
@tk0miya tk0miya modified the milestones: 2.0, 1.6.4, 1.7 Sep 6, 2017
@shimizukawa shimizukawa modified the milestones: 1.7, 1.8 Jan 7, 2018
@tk0miya tk0miya modified the milestones: 1.8.0, 2.0 Jul 18, 2018
tk0miya added a commit to tk0miya/sphinx that referenced this issue Mar 9, 2019
@tk0miya tk0miya modified the milestones: 2.0.0, 1.8.5 Mar 9, 2019
tk0miya added a commit to tk0miya/sphinx that referenced this issue Mar 10, 2019
tk0miya added a commit to tk0miya/sphinx that referenced this issue Mar 10, 2019
tk0miya added a commit to tk0miya/sphinx that referenced this issue Mar 10, 2019
tk0miya added a commit that referenced this issue Mar 10, 2019
…npage

Fix #3859: manpage: code-block captions are not displayed correctly
@tk0miya
Copy link
Member

tk0miya commented Mar 10, 2019

Fixed by #6159.
Thank you for reporting

@tk0miya tk0miya closed this as completed Mar 10, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants