[DOC] Allow Sphinx PDF build to reflow long decimal expansions in code-blocks to avoid them extending beyond page limits #39325
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
5 tasks
Why not put |
Ah sorry I overlooked completely the existence of this conf.py and I should have paid some minimal attention to the lines in the various I knew I was going something wrong, but I really did not have the time to famiiarize myself with the configuration here. I will update my PR later today, can't now. |
|
Documentation preview for this PR (built with commit 4e0e9a8; changes) is ready! 🎉 |
…expansions" This reverts commit ac5a31e.
jfbu
changed the title
@kwankyu Done, thanks. |
kwankyu
approved these changes
Jan 16, 2025
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 19, 2025
…latex work-around
This work-around was needed with Pygments<1.0 hence has been obsolete
for more than fifteen years.
Here is the [relevant commit](https://github.com/pygments/pygments/commi
t/14b9433c05086beb67aca7436a96d1e685787d93) from Pygments:
```text
commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date: Fri Sep 12 00:28:08 2008 +0200
Don't define \at, \lb, \rb as escapes, but prepend commandprefix
here too.
```
Update: it is possible early-history Sphinx had some hardcoded things
nowadays imported dynamically from Pygments such as the contents of the
file `sphinxhighlight.sty` one finds in the latex build directory (which
does currently `\def\PYGZat{@}`). Indeed I also found a [similar commit
at Sphinx](https://github.com/sphinx-
doc/sphinx/commit/46544e4986fd2dbdf11d79897c18ef6623956db6),
```text
commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date: Thu Sep 11 22:29:35 2008 +0000
Use a prefix to \at, \lb and \rb since they are probably often used
command names.
```
which was part of [Sphinx 0.5 release](https://github.com/sphinx-
doc/sphinx/releases/tag/v0.5) from November 2008. It is not fully clear
to me why sagemath#8183 was raised in February 2010, but anyway I am very
confident the issue does not exist at all if producing the PDF docs with
a reasonable version of Sphinx.
There is another conf.py with this work-around but sagemath#39325 already
handles it.
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.
### ⌛ Dependencies
<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
URL: sagemath#39326
Reported by: Jean-François B.
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 20, 2025
…latex work-around
This work-around was needed with Pygments<1.0 hence has been obsolete
for more than fifteen years.
Here is the [relevant commit](https://github.com/pygments/pygments/commi
t/14b9433c05086beb67aca7436a96d1e685787d93) from Pygments:
```text
commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date: Fri Sep 12 00:28:08 2008 +0200
Don't define \at, \lb, \rb as escapes, but prepend commandprefix
here too.
```
Update: it is possible early-history Sphinx had some hardcoded things
nowadays imported dynamically from Pygments such as the contents of the
file `sphinxhighlight.sty` one finds in the latex build directory (which
does currently `\def\PYGZat{@}`). Indeed I also found a [similar commit
at Sphinx](https://github.com/sphinx-
doc/sphinx/commit/46544e4986fd2dbdf11d79897c18ef6623956db6),
```text
commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date: Thu Sep 11 22:29:35 2008 +0000
Use a prefix to \at, \lb and \rb since they are probably often used
command names.
```
which was part of [Sphinx 0.5 release](https://github.com/sphinx-
doc/sphinx/releases/tag/v0.5) from November 2008. It is not fully clear
to me why sagemath#8183 was raised in February 2010, but anyway I am very
confident the issue does not exist at all if producing the PDF docs with
a reasonable version of Sphinx.
There is another conf.py with this work-around but sagemath#39325 already
handles it.
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.
### ⌛ Dependencies
<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
URL: sagemath#39326
Reported by: Jean-François B.
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 23, 2025
…latex work-around
This work-around was needed with Pygments<1.0 hence has been obsolete
for more than fifteen years.
Here is the [relevant commit](https://github.com/pygments/pygments/commi
t/14b9433c05086beb67aca7436a96d1e685787d93) from Pygments:
```text
commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date: Fri Sep 12 00:28:08 2008 +0200
Don't define \at, \lb, \rb as escapes, but prepend commandprefix
here too.
```
Update: it is possible early-history Sphinx had some hardcoded things
nowadays imported dynamically from Pygments such as the contents of the
file `sphinxhighlight.sty` one finds in the latex build directory (which
does currently `\def\PYGZat{@}`). Indeed I also found a [similar commit
at Sphinx](https://github.com/sphinx-
doc/sphinx/commit/46544e4986fd2dbdf11d79897c18ef6623956db6),
```text
commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date: Thu Sep 11 22:29:35 2008 +0000
Use a prefix to \at, \lb and \rb since they are probably often used
command names.
```
which was part of [Sphinx 0.5 release](https://github.com/sphinx-
doc/sphinx/releases/tag/v0.5) from November 2008. It is not fully clear
to me why sagemath#8183 was raised in February 2010, but anyway I am very
confident the issue does not exist at all if producing the PDF docs with
a reasonable version of Sphinx.
There is another conf.py with this work-around but sagemath#39325 already
handles it.
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.
### ⌛ Dependencies
<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
URL: sagemath#39326
Reported by: Jean-François B.
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 25, 2025
…latex work-around
This work-around was needed with Pygments<1.0 hence has been obsolete
for more than fifteen years.
Here is the [relevant commit](https://github.com/pygments/pygments/commi
t/14b9433c05086beb67aca7436a96d1e685787d93) from Pygments:
```text
commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date: Fri Sep 12 00:28:08 2008 +0200
Don't define \at, \lb, \rb as escapes, but prepend commandprefix
here too.
```
Update: it is possible early-history Sphinx had some hardcoded things
nowadays imported dynamically from Pygments such as the contents of the
file `sphinxhighlight.sty` one finds in the latex build directory (which
does currently `\def\PYGZat{@}`). Indeed I also found a [similar commit
at Sphinx](https://github.com/sphinx-
doc/sphinx/commit/46544e4986fd2dbdf11d79897c18ef6623956db6),
```text
commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date: Thu Sep 11 22:29:35 2008 +0000
Use a prefix to \at, \lb and \rb since they are probably often used
command names.
```
which was part of [Sphinx 0.5 release](https://github.com/sphinx-
doc/sphinx/releases/tag/v0.5) from November 2008. It is not fully clear
to me why sagemath#8183 was raised in February 2010, but anyway I am very
confident the issue does not exist at all if producing the PDF docs with
a reasonable version of Sphinx.
There is another conf.py with this work-around but sagemath#39325 already
handles it.
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.
### ⌛ Dependencies
<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
URL: sagemath#39326
Reported by: Jean-François B.
Reviewer(s): Kwankyu Lee
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jan 26, 2025
…latex work-around
This work-around was needed with Pygments<1.0 hence has been obsolete
for more than fifteen years.
Here is the [relevant commit](https://github.com/pygments/pygments/commi
t/14b9433c05086beb67aca7436a96d1e685787d93) from Pygments:
```text
commit 14b9433c05086beb67aca7436a96d1e685787d93
Author: Georg Brandl <[email protected]>
Date: Fri Sep 12 00:28:08 2008 +0200
Don't define \at, \lb, \rb as escapes, but prepend commandprefix
here too.
```
Update: it is possible early-history Sphinx had some hardcoded things
nowadays imported dynamically from Pygments such as the contents of the
file `sphinxhighlight.sty` one finds in the latex build directory (which
does currently `\def\PYGZat{@}`). Indeed I also found a [similar commit
at Sphinx](https://github.com/sphinx-
doc/sphinx/commit/46544e4986fd2dbdf11d79897c18ef6623956db6),
```text
commit 46544e4986fd2dbdf11d79897c18ef6623956db6
Author: Georg Brandl <[email protected]>
Date: Thu Sep 11 22:29:35 2008 +0000
Use a prefix to \at, \lb and \rb since they are probably often used
command names.
```
which was part of [Sphinx 0.5 release](https://github.com/sphinx-
doc/sphinx/releases/tag/v0.5) from November 2008. It is not fully clear
to me why sagemath#8183 was raised in February 2010, but anyway I am very
confident the issue does not exist at all if producing the PDF docs with
a reasonable version of Sphinx.
There is another conf.py with this work-around but sagemath#39325 already
handles it.
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.
### ⌛ Dependencies
<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
URL: sagemath#39326
Reported by: Jean-François B.
Reviewer(s): Kwankyu Lee
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update conf.py's for A Tour of Sage in PDF format to fix long decimal expansions.
Before:
After:
Additional notes: EDIT The below is partially obsolete. The change has been moved to
sage_docbuld/conf.pyfollowing #39325 (comment)\atLaTeX control sequence needing to be undefined to avoid conflict with babel-french, because I am not aware of Sphinx defining any\atat all in the preamble it creates in output.texfile, I suspected this is long obsolete, there is no\atdefinition to be found in any of Sphinx LaTeX support files and I have never encountered such an issue in my practice of Sphinx with French language.latex_elements['preamble']but except if there is some import during the build of some other conf.py, which appears not to be the case, a direct assignment as done in PR should be equivalent.The PR only affects the various A Tour of Sage documents but may perhaps be profitably extended to more Sage documentation in future.
📝 Checklist
⌛ Dependencies