Easy-up user customization of \sphinxcode LaTeX macro
#4370
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for quick review @tk0miya ! I will move the line next to the other macro definitions, (i.e. after the long Before merge I will force push this squashed change for a cleaner commit history. I have been tempted to replace |
…te`` Since sphinx-doc#2627 (1.4.4), `\code`, and then again at sphinx-doc#3116 (1.5) `\sphinxcode` which is the new name has become more complicated than the original `\texttt{#1}`. This was to obtain straight quotes in PDF output, and to allow long inline literals to break across lines. This means though that users who want to customize `\sphinxcode`, for example to not only do `\texttt` but to use some colour, have to copy about 10 lines of complicated LaTeX macros which should be not modified in any way. This commit moves all the code out of `\sphinxcode` into a separate macro `\sphinxupquote`. The LaTeX writer will output `\sphinxcode{\sphinxupquote{foo}}` in place of former `\sphinxcode{foo}`. Moving the `\texttt` from innermost to outermost level is with no consequence.
This make clearer to average LaTeX user the format which is expected for these macros, in case of redefinitions.
jfbu
force-pushed
the
easier_sphinxcode
branch
from
d75b434 to
680d676
Compare
jfbu
added a commit
that referenced
this pull request
Jan 3, 2018
This is subtle LaTeX thing. Prior to merge of #4370 there was a `\texttt` which was hiding the potential problem. The fix is to leave a brace pair in place.
|
a space gobbling issue in |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split out fancy LaTeX macros from
\sphinxcodeinto\sphinxupquoteSince #2627 (1.4.4),
\code, and then again at #3116 (1.5)\sphinxcodewhich is the new name has become more complicated than the original\texttt{#1}. This was to obtain straight quotes in PDF output, and to allow long inline literals to break across lines.This means though that users who want to customize
\sphinxcode, for example to not only do\textttbut to use some colour, have to copy about 10 lines of complicated LaTeX macros which should be not modified in any way. This commit moves all the code out of\sphinxcodeinto a separate macro\sphinxupquote.The LaTeX writer will output
\sphinxcode{\sphinxupquote{foo}}in place of former\sphinxcode{foo}. Moving the\textttfrom innermost to outermost level is with no consequence.A second commit uses easier to understand way of defining the other styling macros, so that LaTeX user examining
sphinx.stysees more easily how the macros are supposed to be defined.