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

Naked .. code-block:: bash in some places throughout docs #3118

Closed
posita opened this issue Sep 7, 2023 · 4 comments · Fixed by #3120
Closed

Naked .. code-block:: bash in some places throughout docs #3118

posita opened this issue Sep 7, 2023 · 4 comments · Fixed by #3120
Labels
bug:minor does not affect many people or has no big impact help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted.

Comments

@posita
Copy link
Contributor

posita commented Sep 7, 2023

Issue

From Overriding configuration from the command line:

Screenshot from 2023-09-07 13-47-46

Apparent source: #3111

This page appears to be generated from config.rst. I'm not quite sure what the problem is here, since some code blocks work, but others (perhaps those with only a single line) don't. It's interesting to note that GH's renderer suffers from the same problem.

So this may be a bug in Sphinx, but if a work-around is available (or maybe selecting an alternative Sphinx version fixes this), it is probably worth exploring for the sake of a polished experience for doc consumers.

@gaborbernat
Copy link
Member

PR welcome 👍

@gaborbernat gaborbernat added bug:minor does not affect many people or has no big impact help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. labels Sep 7, 2023
@posita posita removed their assignment Sep 7, 2023
@posita
Copy link
Contributor Author

posita commented Sep 7, 2023

I don't know how to fix this. I tried tinkering with some obvious things, but nothing worked locally. It's more complicated than a trivial fix. Investigation seems to be involved, and I'm no longer familiar with Sphinx. I gave up on it a long time ago because of fighting with stuff like this.

If you want me to revert the portions of #3111 that led to the problem, then please reassign this to me. (That I can do.)

UPDATE: Nope. I see the problem now. See this comment.

@gaborbernat
Copy link
Member

No we should fix it rather than revert it.

@posita
Copy link
Contributor Author

posita commented Sep 7, 2023

Gah! I think I see the problem now (prior #3118 (comment) revised above). PR pending. Should be posted soon posted: #3120. Please reassign to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug:minor does not affect many people or has no big impact help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants