Breakable inline literals in LaTeX #3116
Merged
Conversation
This file contains 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
modified: sphinx/texinputs/sphinx.sty
also use ``\sphinxcode`` for literals in titles which will add the extras (straight quotes, breaks allowed at ``/`` and some other characters)
this makes the LaTeX macros more robust, less worrying about where they are used.
|
@tk0miya Travis reported failure, only with Python=2.7 and docutils=1.12, for ee8b558: https://travis-ci.org/sphinx-doc/sphinx/jobs/173034777#L1447 with an error which seems unrelated with the present commits. However child commit aa1ea9b did not trigger this error report but its diff to the previous modified only quite older code, hence the Travis error report looks like a quantum singularity ;-) |
|
Agreed about the error. I will investigate it later if it raises again. |
|
thanks as always @tk0miya, merging. |
|
@tk0miya later today I will add a commit to make this behaviour optional in case people want to maintain exact same as before i.e. no linebreaks with inline literals at |
jfbu
added a commit
to jfbu/sphinx
that referenced
this pull request
Jan 2, 2018
…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 codes in PDF output, and to allow long inline literals to break across lineswq. This means though that user who wants to customize `\sphinxcode`, for example to not only do `\texttt` but to use some colour, has to copy about 10 lines of complicated LaTeX macros with @ letter. This moves all the code out of `\sphinxcode` into new macro `\sphinxupquote`. The LaTeX files will contain `\sphinxcode{\sphinxupquote{foo}}` in place of former `\sphinxcode{foo}`. Moving the `\texttt` from innermost to outermost level is with no consequence.
jfbu
added a commit
to jfbu/sphinx
that referenced
this pull request
Jan 2, 2018
…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.
jfbu
added a commit
to jfbu/sphinx
that referenced
this pull request
Jan 3, 2018
…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.
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.
Addresses #3110. Also, unify handling of inline literals by applying to all types (literalintitle, literalstrong, literalemphasis) use of
\sphinxcoderather than simply\texttt(which was the old definition of\sphinxcodeaka\code). Also, use\protectedprefix (Sphinx assumes for long time e-TeX via use of\ifdefined,\dimexpr... hence we should also use\protectedfor more robust macros).